This repository contains material used to generate the Madara documentation website.
This website is built using Docusaurus, a modern static website generator.
Madara is both a Starknet full node and an appchain (L3).
The documentation explains all of the functionality of Madara, both from full node perspective and appchain perspective. The documentation is still under development: new sections get added all the time and existing ones get appended to.
npm i
npm run 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.
The main branch of the repository is automatically deployed to madara-docs.pages.dev. Additionally, previews are deployed automatically for all PRs, allowing you to review changes before they are merged.
The search bar utilizes a local search index with a plugin .
Whenever needed, the index can be manually updated by: npm run build. To see the changes in local development, use npm run serve.
Contributions from the community are warmly welcomed!
If you find an issue with the documentation, please open an issue in the repo. You are also welcome to open a PR to fix any found issues.