Fims Documentation

A wiki site of prototype project Fims.

Link to the docs.

How to contribute

1. Install mkdocs and others

1.1. Install mkdocs

pip install mkdocs

(If pip is not found, consider export it):

export PATH="$PATH:$HOME/Library/Python/3.9/bin"

1.2. Install mkdocs-material theme

pip install mkdocs-material

mkdocs-material integrates with mermaid natively, no need to install mkdocs-mermaid2-plugin plugin.

2. Make your change in markdown files

For full documentation visit mkdocs.

3. Verify locally

Run command to serve mkdocs locally:

mkdocs serve

4. Deploy the docs

Commit the changes of source file into main branch.

Run command:

mkdocs gh-deploy

mkdocs will generate site files in /site folder and push to gh-pages branch.

Now the changes should be visible in github pages: https://fims-proto.github.io/documentations/