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, it will be created into its own, new directory using npm run docusaurus docs:version x.y.z
As per the latest Docusaurus file structure, please place new static images in the /static/img/ directory in an organized fashion.
When referring to an image in a markdown file, please use absolute paths according to the following markdown syntax: 
When linking to local pages, please do not use http urls or relative paths to link to other markdown documents that are part of the docusaurus site.
For easier maintenance and organization, use absolute paths starting from the root directory eg: /docs/quickstart/Name_of_markdown.md.
Autocomplete on VS Code should find the directories automatically.
Linking to headings within the document work as well by using # following the filename.
- The search plugin used is docusaurus-lunr-search: https://github.com/praveenn77/docusaurus-lunr-search
- Alternative search plugin: https://github.com/easyops-cn/docusaurus-search-local
- Image zoom plugin: https://github.com/gabrielcsapo/docusaurus-plugin-image-zoom