Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

index online Stan manuals for search and add controls to top-level search page #78

Open
mitzimorris opened this issue Dec 28, 2018 · 1 comment

Comments

@mitzimorris
Copy link
Member

the Stan documentation has been converted to RMarkdown format which is markdown plus latex's mathjax for the math and R chunks for producing charts and graphs and running programs.
we are using the R bookdown program to generate the HTML documentation.
the generated docs have mediocre in-document search.

it would be possible to provide better cross-document search via lunr.js which provides decent lucene/elasticsearch-like behavoir. with lunr.js search is client-side. the sticking point is that the client must first download the search index which can be quite large - once the search index is downloaded, search is lighting fast.

this would be a nice project for a javascript developer.

@mitzimorris
Copy link
Member Author

currently investigating Algolia search -
https://community.algolia.com/docsearch/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant