Welcome to the documentation directory for Calimero Network. This directory contains all the necessary files to build and run the project documentation locally, contribute changes, and deploy updates.
Follow these steps to get started with the documentation:
- Ensure you have Node.js installed (version 18 or later).
- pnpm is our package manager of choice. If you don't have it installed, follow the installation instructions.
-
Clone the repository (if you haven't already):
git clone https://github.com/calimero-network.git cd yourproject/docs -
Install the dependencies:
pnpm install
-
Running the Documentation Locally To start a local development server and open the documentation in your browser:
```bash pnpm 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.
- Contributing We welcome contributions to our documentation! To contribute:
Create a branch for your changes:
git checkout -b docs/my-documentation-changeMake your changes and preview them locally by running pnpm start.
Commit your changes:
git commit -am "docs: Add some amazing documentation"Push your branch and open a pull request against the main branch.
- Deployment
This command builds the documentation and pushes it to the gh-pages branch, automatically updating the live documentation site.
docs/: Contains the Markdown files for the documentation. blog/: Contains the Markdown files for the blog. sidebars.js: Configures the documentation sidebar. Currently autogenerated. docusaurus.config.js: Contains configuration for Docusaurus, including theme and plugin settings.
If you encounter any issues or have questions about contributing to the documentation, please open an issue on GitHub.
Thank you for contributing to Calimero Network's documentation!