This project is the new and updated documentation built using Docusaurus V3.9. The current INAV documentation is scattered about in the Github Wiki and the docs directory of the main project. This documentation attempts to consolidate all the knowledge about INAV into a centralized, easy to access and read location.
To build and run the docs locally, install npm on your system and follow the Docusaurus installation instructions.
- Prepare the environment with
npm run clearandrm package-lock.json. - Make sure all packages are installed with
npm install. - Run the dev server with
npm run start.
Documentation can be accessed at this URL: https://inavflight.github.io/
The website utilizes Docusaurus's versioning feature to keep track of major changes to the firmware.
The current version is the active stable release in /versioned_docs/version-x.x.x directory that has been frozen with no further updates.
Upon the release of the next stable version, a new version will be created into its own directory using npm run docusaurus docs:version x.y.z
Lastly, the next current version's label will have to updated manually in docusaurus.config.ts.
- The search plugin used is docusaurus-lunr-search: https://github.com/praveenn77/docusaurus-lunr-search
- Image zoom plugin: https://github.com/gabrielcsapo/docusaurus-plugin-image-zoom