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

1. Run from the project directory:

   mkdocs gh-deploy

2. MkDocs send the commit and push to the gh-pages branch. The site will be updated within a few minutes.

You should never edit files in your pages repository by hand if you're using the gh-deploy command because you will lose your work the next time you run the command.

Configuration

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