This repository contains the technical documentation for Voedger. The documentation is built using Docusaurus and deployed to GitHub Pages.
- Node.js 20.10 LTS or higher
- npm 10.0 or higher
- Git
- Clone the repository:
git clone https://github.com/voedger/voedger-docs.git
cd voedger-docs- Install dependencies:
npm install- Start the development server:
npm startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
To build the static site:
npm run buildThis command generates static content into the build directory and can be served using any static contents hosting service.
To serve the built site locally:
npm run serveSee CONTRIBUTING.md for detailed guidelines on how to contribute to this documentation.
- Edit Documentation: All documentation files are located in the
docs/directory - Test Locally: Run
npm startto preview your changes - Submit Changes: Create a pull request with your changes
docs/- Documentation content in markdown formatstatic/- Static assets (images, files)sidebars.js- Navigation sidebar configurationdocusaurus.config.js- Site configuration
The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch. The deployment is handled by GitHub Actions (see .github/workflows/deploy.yml).
If needed, you can deploy manually:
npm run deployThis documentation has been migrated from GitBook to Docusaurus. Migration scripts are available in the scripts/ directory:
scripts/migrate-content.js- Migrate content from GitBook exportscripts/format-content.js- Format and optimize markdown contentscripts/validate-links.js- Validate internal and external links
node scripts/migrate-content.js <gitbook-export-path> <output-path>node scripts/validate-links.js docs/