Generate Docs with spago-docs-search

JordanMartinez / learn-halogen

Learn purescript-halogen using a bottom-up apporach via this "clone-and-play" repository

188 stars 28 forks source link

Generate Docs with spago-docs-search #31

Closed zhujinxuan closed 5 years ago

zhujinxuan commented 5 years ago

Hi, thank you for this nice project.

In reading the projects, it always include some looking up definitions through ./generated-docs/index.html. https://github.com/spacchetti/purescript-docs-search provides a nice search box to easy the search process.

Perhaps it is nice to add the docs-search in the project.

JordanMartinez commented 5 years ago

Thanks! I like that idea. I knew the author had recently claimed to have created something like this, but I wasn't aware of this project.

JordanMartinez commented 5 years ago

To resolve this issue, we would need to

Add a step to install that package in the Requirements part of this project's ReadMe
Add a step to run that command in the Instructions part of this project's ReadMe
Update the .travis.yml file to install that project and run its command to verify it still works over time.

klntsky commented 5 years ago

Very likely you don't need to do anything, cause the purescript-docs-search project will soon be integrated into spago, and you already recommend installing spago at the requirements section of the README.

JordanMartinez commented 5 years ago

Great! Looking forward to it!

klntsky commented 5 years ago

Yep, it happened.

zhujinxuan commented 5 years ago

Great, thank you @klntsky . I think I can close this issue now.