-
Notifications
You must be signed in to change notification settings - Fork 3
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
chore(ci): create workflow to check the FrontMatter information in markdown #7
Comments
Although the workflow introduced by #13 checks for reference to new files, we still do not have a way of checking on pre-existing ones. Suggestion: modify this script, adding the possibility to run locally against all markdown files. |
PR closed due to replacement of the script with Docusaurus own sasnity checks and additional Markdown linters. |
Problem
Docussaurus builds the sidebar according to the directory structure, detecting markdown files and listing the pages accordingly.
Docussaurus uses FrontMatter information to add the page's title and metadata.
We have a file
sidebars.json
with a list of files, check that is being used by thecheck_sidebars.py
script.Solution
Check if
sidebars.json
and if thecheck_sidebars.py
is relevant, remove if not, document if it is.Bring a CI check for presence and conformance of the FrontMatter header.
Non-goals
The text was updated successfully, but these errors were encountered: