The online documentation built with Docusaurus for unified modular hypervisor AxVisor.
English | 中文
This repository is the source repository for the AxVisor documentation built using Docusaurus. Docusaurus is an open-source website generator tool developed by Meta, based on React, for creating, maintaining, and deploying static websites.
Docusaurus is actually a set of Node.js packages, so this documentation is essentially a Node.js application. Therefore, the first step is to ensure that the Node.js environment is correctly installed.
- Yarn is used as the package manager. By default, yarn is not installed in Node.js, so first, use the command
npm install -g yarnto install it globally. - To start development for the first time, you need to run the command
yarn installto install the required dependencies. - Use any editor (VS Code is recommended) to modify the source code and edit new documents (all in Markdown format)
mdbook is a documentation system that uses Markdown files as source files. Therefore, we only need to write the source files using Markdown syntax.
The ./src/SUMMARY.md file in the source code is the table of contents for the documentation. When new source files are added, their corresponding file paths need to be added to this file.
Running the command yarn start will start a local development server and automatically open a browser window to preview the entire website.
Currently, the AxVisor documentation website is hosted on GitHub Pages: https://arceos-hypervisor.github.io/axvisorbook/. The repository is configured to deploy via GitHub Actions by default. Once the source code is committed to the repository, GitHub Actions will be automatically triggered to deploy the site.
Feel free to fork this repository and submit a PR.
AxVisor Book uses the following open-source license:
- Apache-2.0
- MulanPubL-2.0
- MulanPSL2
- GPL-3.0-or-later