adi-mkdocs-harmonic 0.6.0

An ADI Harmonic theme for mkdocs based on mkdocs-material

Installing & Using the ADI Harmonic Theme for MkDocs

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.

Installation

Prerequisites

• Python 3.10 or greater

Install using Pip

pip install adi-mkdocs-harmonic

Creating and running a skeleton MkDocs project

1. Create a mkdocs.yml file in the project directory with the following contents:

   site_name: My Project
   theme:
       name: harmonic
   

2. Create a docs folder with an index.md file in it with the following contents:

   ---
   title: My project
   ---
   
   Some overview text
   
   ## A subheading
   
   Subheading text
   

3. Run mkdocs serve in the terminal and open your web browser to https://localhost:8000