This directory contains the Docusaurus-powered documentation website for Actvt, hosted at docs.actvt.io.
Start the development server:
npm startThis opens a browser window at http://localhost:3000 which shows the intro page directly at the root. Most changes are reflected live without restarting the server.
Generate static content:
npm run buildThis generates static content into the build directory for production deployment.
Test the production build locally:
npm run serveThis site is configured for deployment to Cloudflare Pages:
- Build command:
npm run build - Build output directory:
build - Root directory:
docusaurus
- Production URL:
https://docs.actvt.io(intro page served at root/) - Configured in:
wrangler.toml
The site automatically deploys to Cloudflare Pages when changes are pushed to the main branch.
docs/ # Documentation source files
├── intro.md # Homepage/intro documentation
├── getting-started/ # Installation and quick start guides
└── remote-server/ # Remote monitoring setup guides
└── provider-guides/ # Cloud provider specific guides
src/ # React components and custom pages
├── components/ # Reusable React components
├── css/ # Custom CSS and themes
└── pages/ # Custom pages (homepage, etc.)
static/ # Static assets (images, favicon, etc.)
docusaurus.config.ts # Main configuration file
sidebars.ts # Manual navigation sidebar (main sections expanded, provider guides collapsed)
- ✅ Offline Search: Local search functionality via
@easyops-cn/docusaurus-search-local - ✅ Custom Branding: Actvt logo, themed colors, and system fonts
- ✅ Responsive Design: Mobile-friendly documentation
- ✅ SEO Optimized: Meta tags, keywords, and social cards
- ✅ Syntax Highlighting: Code blocks with bash, JSON, and TOML support
- ✅ Dark Theme: Clean dark theme optimized for readability
To update documentation:
- Edit files in the
docs/directory - Test locally with
npm start - Build and verify with
npm run build && npm run serve - Commit and push changes for automatic deployment