MkDocs development guide

For full documentation visit mkdocs.org.

Commands

mkdocs new [dir-name] - Create a new project.
mkdocs serve - Start the live-reloading docs server.
mkdocs build - Build the documentation site.
mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Documentation Flow

This section defines necessary steps to wok with the MkDocs Material Framework.
The framework presents a static site generator with documentation written in Markdown.
All the docs are configured with a YAML configuration file.

There are two options for working with MkDocs:

MkDocs via Podman/Docker
MkDocs via Python PIP

MkDocs via Podman/Docker

Prerequisites

Workflow

Clone the edp-install repository to your local folder.
Run the following command:
```
make docs
```
For Docker
```
make docs ENGINE=docker
```
Enter the http://localhost:8000 address in the browser and check that documentation pages are available.
Open the editor, navigate to the docs/ directory and make necessary changes. All the changes will be updated dynamically at http://localhost:8000.
Create a merge request with changes or deploy to GitHub pages manually:
```
mkdocs gh-deploy --force
```

MkDocs via Python PIP

Prerequisites

Workflow

Run the following command:

pip install -r  docker-image/mkdocs/requirements.txt

Run a local development server:

mkdocs serve --dev-addr 0.0.0.0:8000

For Windows:

python -m mkdocs serve --dev-addr 0.0.0.0:8000

Enter the http://localhost:8000 address in the browser and check that documentation pages are available.
Open the editor, navigate to the docs/ directory and make necessary changes. All the changes will be updated dynamically at http://localhost:8000.
Create a merge request with changes or deploy to GitHub pages manually:
```
mkdocs gh-deploy --force
```