-
Notifications
You must be signed in to change notification settings - Fork 105
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
Migrate to Docusaurus #236
Comments
cc @hegemonic |
Almost created the same PR. If the effort is really small, then it's worth doing! |
@Aleksandr-JS-Developer it's a one time effort. I have already created this non-breaking PR and the resulting site would be as good as the current one w.r.t existing experience, plus it will also have the additional features mentioned in the issue except search. However, I haven't been able to get any response from the maintainers, thus stuck with a pending PR. |
try this https://github.com/kejunmao/jsdoc preview: https://vjsdoc.netlify.app/ |
The current site misses out on a few important features now standard across modern documentation sites. Such as:
This causes significant inconvenience to developers browsing the site, especially when in need for quick reference. Proposing to migrate from Metalsmith to Docusaurus as it provides the above features out of the box along with many others.
I tried this migration with my fork, and was able to do it with minimal changes in the existing markdown contents and without breaking the existing links and redirects. Refer:
I will go ahead a raise a PR for the migration without Search feature. Read here for the Docusaurus search support.
The text was updated successfully, but these errors were encountered: