An ADI Harmonic theme for mkdocs based on mkdocs-material
Project description
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
-
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
adi_mkdocs_harmonic-0.7.0.tar.gz
(16.4 kB
view hashes)
Built Distribution
Close
Hashes for adi_mkdocs_harmonic-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c1ef4b761cc534d8eaeb9d2caa918e14388160bad47bdc15b4d57fd9672d78b |
|
MD5 | 64266ac7aecf6e817eb770129ed0d3eb |
|
BLAKE2b-256 | ceb738d4d0a1d48c5ab5b5f7578d4f6e27120b247de538a53f5438578b1acd11 |
Close
Hashes for adi_mkdocs_harmonic-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e13b063d4fd0df8494186fc0e0beaa59926cdb1b337df6dd93f8564f133699a7 |
|
MD5 | d5ba534834cd44be3db11b6bd0348055 |
|
BLAKE2b-256 | b02f5f74f298c7977a4771f53327e9c97df32fa875d7a937f78e11d19df944c6 |