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

Consider alternative to mdbook #161

Open
joepio opened this issue Dec 4, 2023 · 0 comments
Open

Consider alternative to mdbook #161

joepio opened this issue Dec 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@joepio
Copy link
Member

joepio commented Dec 4, 2023

I'm pretty happy with mdbook, but maybe there are better ways to turn the docs into a site. Ideally:

  • Site looks nice and modern (mdboo looks a little basic)
  • Autocomplete in search would be nice
  • Custom pages support
  • Preferably with React / Svelte (which I'm familiar with)

Options:

  • MDBook has great rust support, but some short comings (see above)
  • Vitepress looks great, but only vue
  • KitDocs is svelte, but relies on algolia for search
@joepio joepio added the documentation Improvements or additions to documentation label Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant