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

Implement script to automatically check and update sidebars.js and homepage-categories.js #14

Open
Kent55 opened this issue Mar 23, 2020 · 1 comment

Comments

@Kent55
Copy link
Contributor

Kent55 commented Mar 23, 2020

Currently, in order to add to the documentation, aside from adding the relevant markdown files, manual edits to the sidebars.js and homepage-categories.js files are needed. In order to display a new article in the sidebar, a reference to the article needs to be added to the sidebars.js file under the relevant category. When adding a new category, a new category object needs to be added to this file, and furthermore a new item needs to be added to the homepage-categories.js file to display it on the homepage.

In order to increase appeal to the community in assisting with documentation, it might be worth adding a script to which traverses the docs directory and adds any new relevant config automagically to the two files, respectively.

@Kent55
Copy link
Contributor Author

Kent55 commented Jul 17, 2020

This has been developed in a separate repo as a custom Docusaurus plugin which will also be made public via NPM. Currently debating whether to keep the plugin repo separate or contain it within this one and create a "mono-repo".

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