Skip to main content

Live Documentation (Docusaurus)

Website
https://docusaurus.io/

The project includes built-in documentation based on Docusaurus. It is located in the docs/ folder.

Live Documentation: 🚀 View Docs

Running Locally​

  1. Go to the folder: cd docs
  2. Install dependencies: npm install
  3. Start the server: npm start (changes should refresh automatically)
  4. Start adding content

Automation (GitHub Actions)​

The .github/workflows/publish_docs.yml workflow automatically:

  • Builds the documentation on every push to main.
  • Deploys a PR Preview for every Pull Request.
  • Publishes the ready site to GitHub Pages.

Post-Clone Checklist​

After using this template to create a new project, follow these steps to fully configure the infrastructure:

  • GitHub Pages: Go to Settings -> Pages. In the Build and deployment -> Source section, select "Deploy from a branch". Choose the gh-pages branch (it will appear after the first workflow run) and the / (root) folder.
  • Docusaurus Config: Update the docs/docusaurus.config.ts file. Change url, organizationName, and projectName to your new repository details.

Technical details​

Note

This section is more for GenAI, to automatically copy this feature to other places.

Changelog​

  • Initial release v1.0.0
    • Built-in Docusaurus documentation site under docs/.
    • Automated build, PR preview and GitHub Pages deploy via .github/workflows/publish_docs.yml.

Files​

Files which are involved in this feature. Note that many of them might be just standard files and details about them should be looked up in the documentation. They might also contain elements from other features.

  • docs/**
  • .github/workflows/publish_docs.yml