Docusaurus App
This is the documentation site for the monorepo, built with Docusaurus. Like the other apps, it's named after its purpose for clear identification.
Application Structure
The documentation app is organized as follows:
apps/docusaurus/
├── api/ # Simple authentication server for protected docs
├── docs/ # Documentation content organized by sections
│ ├── project-docs/ # Project-specific documentation
│ └── repo-configuration/ # Monorepo setup documentation
├── src/ # Custom Docusaurus components
│ ├── components/ # Reusable UI components
│ ├── css/ # Global CSS styles
│ ├── pages/ # Landing pages
│ └── theme/ # Theme customizations
└── static/ # Static assets like images and icons
Features
- Docusaurus 3 for documentation site generation
- React 19 for UI components
- MDX support for interactive documentation
- Clerk integration for authenticated documentation
- Theme customization for brand consistency
Key Files
docusaurus.config.ts
: Main configuration file for Docusaurussidebars.ts
: Documentation sidebar structureapi/server.mjs
: Authentication server for protected documentation
📄️ Set up Docusaurus
Set up the Config
📄️ Local Development
From the apps/docusaurus directory run pnpm run start to start the Docusaurus server.
📄️ Deployment
To share with PMs and clients this Docusaurus project can be deployed through Vercel and secured using Clerk.
📄️ What to Document
This guide outlines the documentation requirements for our projects at Labrys. Proper documentation is a critical part of our development workflow and is required for PR approval.
📄️ How to use Docusaurus
See Set up Docusaurus for details on how to set Docusaurus up for your project.
📄️ Docusaurus App
This is the documentation site for the monorepo, built with Docusaurus. Like the other apps, it's named after its purpose for clear identification.
📄️ MDX
Docusaurus has built-in support for MDX, which allows you to write JSX within your Markdown files and render them as React components.