protocol-mkdocs.md

How to work with MkDocs

docs.rarible.org is building with MkDocs and deploying to GitHub Pages. Documentation source files have been written in Markdown and configured with the mkdocs.yml.

Requirements for work with MkDocs:

• Python
• pip

Installation

1. Install MkDocs:

   pip install mkdocs

2. Install Material Theme for MkDocs:

   pip install mkdocs-material

Usage

1. Clone the repository with docs.

2. Switch to the required branch or create it.

3. Make changes, commit and push.

4. For checking the changes locally, run the command in the project directory:

   mkdocs serve

5. Open up http://127.0.0.1:8000/ in your browser.

Changes in the documentation will be displayed immediately.

Deploying

Merge pull requests or push changes to GitHub main branch. The site will be automatically built and deployed within a few minutes.

You should never edit files in your pages repository by hand. Because you will lose your work the next time you push the changes.

Configuration

• MkDocs documentation for configurate settings.
• Material documentation for configurate theme and extentions.