Welcome to the NorAir Labs Documentation repository! This project uses Docusaurus to create and manage our documentation. Below, you will find instructions on how to set up the project, use Docusaurus, and contribute to our documentation.
Before you begin, make sure you have the following installed on your local machine:
- Node.js (version .x or later)
-
Clone the repository to your local machine:
git clone https://github.com/norairlabs/docs-norairlabs-com.git cd docs-norairlabs-com -
Install the dependencies:
npm install
To run the documentation site locally, use the following command:
npm run start
This will start a local development server and open the documentation site in your default web browser. Any changes you make to the source files will be reflected live.
To run the documentation site remotely, use the following command:
npm run start -- --host 0.0.0.0
This will start a local development server and open the documentation site in your default web browser. Any changes you make to the source files will be reflected live.
To build the static files for the documentation site, use the following command:
npm run build
The build output will be located in the build directory. You can serve these files using any static file server.
Documentation is stored in the docs directory. Each Markdown file represents a page on the documentation site. Here are some tips for writing good documentation:
- Clear and Concise: Write clear and concise explanations. Avoid unnecessary jargon.
- Examples: Provide examples to illustrate complex concepts.
- Consistency: Follow the existing style and structure of the documentation.
Thank you for contributing to NorairLabs Documentation!