This website is built using Docusaurus 2, a modern static website generator.
Docusaurus uses Markdown and MDX for its content, so there are almost no limits to what can be done on the site.
If you would like to contribute to the blog, add a new entry to the /blog directory. Please follow a metadata format described in the initial post.
Primary documentation is located in the /docs folder. To add a new entry, do the following:
-
Create a new
.mdfile, let's sayexample.md -
In the
example.md, add a heading with the next metadata:id- ID for the file to be referenced in the Docusaurus's navigation and URL structuretitle- Title of the file as it will be shown on the sitesidebar_label- Label of the file for a navigation sidebar
Example for
example.md:id: example title: Example for CG/SQL sidebar_label: Example for CG/SQL -
In /website/sidebars.js, add
idof your newly created site. You will need to either create a new subheading for the sidebar or add your new file under an existing sidebar.Example for
example.md:Resources: ['dev-notes', 'example'],
Similarly to the Docs' contributions, CQL Guide uses Markdown for its files and follow the same pattern for headers' metadata.
The only difference is that instead of using /website/sidebars.js, a contributor needs to work with /website/sidebarsGuide.js