This project is the official documentation website for Nephelios, a lightweight and extensible PaaS built in Rust. The site is powered by Docusaurus 2, a modern static site generator optimized for technical documentation.
To install project dependencies using npm:
npm installTo start a local development server:
npm run startThis will launch the documentation at http://localhost:3000. The site supports hot reloading, so changes to the content or config are automatically reflected in the browser.
To generate a production-ready static version of the site:
npm run buildThe static content will be output to the build/ directory. You can then deploy it with any static hosting service (GitHub Pages, Netlify, Vercel, etc.).
If your GitHub account is configured with SSH:
USE_SSH=true npm run deployUsing HTTPS authentication instead:
GIT_USER=<YourGitHubUsername> npm run deployThis will build the static site and push it to the gh-pages branch of your repository, making it available via GitHub Pages.
- The project supports full Markdown-based content editing.
- You can extend the site with custom React components, plugins, and themes.
- Search, versioning, and multi-language support can easily be enabled.
| Command | Description |
|---|---|
npm run start |
Start dev server with hot reload |
npm run build |
Build static files for production |
npm run deploy |
Build and deploy to GitHub Pages |
npm run swizzle |
Customize theme components |