docs.tryhackme.com
docs.tryhackme.com copied to clipboard
Implement script to automatically check and update sidebars.js and homepage-categories.js
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.
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".