Documentation site
The documentation is a Docusaurus site in website/.
Develop Locally
cd website
npm install
npm start
The development server runs at http://localhost:3000 by default.
Build
cd website
npm run build
The production build is written to website/build/.
Preview the production build locally:
npm run serve
Structure
| Path | Purpose |
|---|---|
docs/ | Markdown/MDX documentation pages. |
sidebars.js | Sidebar structure and audience split. |
docusaurus.config.js | Site config, base URL, title, nav, footer, Mermaid. |
src/css/custom.css | Theme colors. |
static/img/ | Logo and favicon. |
Deploy To GitHub Pages
docusaurus.config.js is preset for:
https://deepphe.github.io/installation/
The config uses organizationName: DeepPhe, projectName: installation, and
baseUrl: /installation/.
Deploy with the team's preferred GitHub Pages workflow, or use the Docusaurus deploy command after confirming credentials and target branch settings.