This repository hosts Safe documentation.
The documentation is built with Nextra and is live at docs.safe.global.
Install the dependencies using pnpm:
pnpm install
Git hooks are set up to run tests and linting checks before every git push. These hooks can be executed locally by running the following command:
pnpm prepush
All links in the documentation are checked for validity on every pull request. These checks can be executed locally by running the following command:
pnpm linkcheck
The project can be run with a server that's executed in development and production mode.
Run the server in development mode using the following command:
pnpm dev
Build the project:
pnpm build
Run the server in production mode using the following command:
pnpm start
Create an environment file in the root of the project and copy the content from the .env.example file using the following command:
cp .env.example .env
Remember to update the environment variables once the .env file is created.
Run the tests using the following command:
pnpm test
This project is licensed under the MIT License.
Contributions are more than welcome! Please open an issue or create a pull request by following our contributions guidelines.