This repository hosts the documentation for the Numeraire project, built using Docusaurus, a modern static website generator.
This documentation provides comprehensive guides, API references, and other resources for using and contributing to Numeraire. Contributions are welcome and encouraged!
To set up the project locally, install the necessary dependencies:
yarn
Start the local development server:
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Generate static content for deployment:
yarn build
This command generates static content into the build directory, which can be served using any static content hosting service.
Deployment happens automatically thanks to Github Actions.
We welcome contributions to improve this documentation. Please see the CONTRIBUTING.md file for guidelines on how to contribute.
The documentation is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).