📄️ Create a Page
Add Markdown or React files to src/pages to create a standalone page:
📄️ Create a Document
Documents are groups of pages connected through:
📄️ Markdown Features
Docusaurus supports Markdown and a few additional features.
📄️ Mermaid Diagrams (UML)
Using Mermaid to create diagrams and visualizations directly in Docusaurus offers significant advantages over static images. With Mermaid, your diagrams are written as code, making them easy to version control, review, and update alongside your documentation. This approach ensures your diagrams always stay in sync with your project, reduces maintenance overhead, and eliminates the hassle of regenerating and uploading new images for every change. As your project evolves, updating a diagram is as simple as editing a few lines of text, making your documentation more agile, consistent, and future-proof.
📄️ Set Environment Variables
This guide explains how to set the PROJECTNAME and ORGNAME environment variables needed for the contributors section to work properly.
📄️ Deploy your site
This template includes automatic deployment to GitHub Pages using GitHub Actions. Every time you push changes to the main branch, your site is automatically built and deployed!
📄️ Congratulations!
You have just learned the basics of Docusaurus and made some changes to the initial template.