The mkdocs-harmonic
theme provides a consistent look and feel for documentation of Analog Devices products generated using MkDocs. This guide will walk you through the steps needed to install and configure the theme for your MkDocs based documentation project.
- Python 3.10 or greater
pip install adi-mkdocs-harmonic
-
Create a
mkdocs.yml
file in the project directory with the following contents:site_name: My Project theme: name: harmonic
-
Create a
docs
folder with anindex.md
file in it with the following contents:--- title: My project --- Some overview text ## A subheading Subheading text
-
Run
mkdocs serve
in the terminal and open your web browser to https://localhost:8000