# Installing & Using the ADI Harmonic Theme for MkDocs
The `mkdocs-harmonic` theme provides a consistent look and feel for documentation of [Analog Devices](https://analog.com) products generated using [MkDocs](https://www.mkdocs.org/). 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](https://www.python.org/downloads/) or greater
## Install using Pip
```sh
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:
```yml
site_name: My Project
theme:
name: harmonic
```
1. Create a `docs` folder with an `index.md` file in it with the following contents:
```md
---
title: My project
---
Some overview text
## A subheading
Subheading text
```
1. Run `mkdocs serve` in the terminal and open your web browser to <https://localhost:8000>
Raw data
{
"_id": null,
"home_page": "https://github.com/analogdevicesinc/harmonic-mkdocs-theme",
"name": "adi-mkdocs-harmonic",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "mkdocs, mkdocs-material, harmonic",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ce/b7/38d4d0a1d48c5ab5b5f7578d4f6e27120b247de538a53f5438578b1acd11/adi_mkdocs_harmonic-0.7.0.tar.gz",
"platform": null,
"description": "# Installing & Using the ADI Harmonic Theme for MkDocs\n\nThe `mkdocs-harmonic` theme provides a consistent look and feel for documentation of [Analog Devices](https://analog.com) products generated using [MkDocs](https://www.mkdocs.org/). This guide will walk you through the steps needed to install and configure the theme for your MkDocs based documentation project.\n\n## Installation\n\n### Prerequisites\n\n- [Python 3.10](https://www.python.org/downloads/) or greater\n\n## Install using Pip\n\n```sh\npip install adi-mkdocs-harmonic\n```\n\n## Creating and running a skeleton MkDocs project\n\n1. Create a `mkdocs.yml` file in the project directory with the following contents:\n\n ```yml\n site_name: My Project\n theme:\n name: harmonic\n ```\n\n1. Create a `docs` folder with an `index.md` file in it with the following contents:\n\n ```md\n ---\n title: My project\n ---\n\n Some overview text\n\n ## A subheading\n\n Subheading text\n ```\n\n1. Run `mkdocs serve` in the terminal and open your web browser to <https://localhost:8000>\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "An ADI Harmonic theme for mkdocs based on mkdocs-material",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://github.com/analogdevicesinc/harmonic-mkdocs-theme",
"Issue Tracker": "https://github.com/analogdevicesinc/harmonic-mkdocs-theme/issues",
"Repository": "https://github.com/analogdevicesinc/harmonic-mkdocs-theme"
},
"split_keywords": [
"mkdocs",
" mkdocs-material",
" harmonic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b02f5f74f298c7977a4771f53327e9c97df32fa875d7a937f78e11d19df944c6",
"md5": "d5ba534834cd44be3db11b6bd0348055",
"sha256": "e13b063d4fd0df8494186fc0e0beaa59926cdb1b337df6dd93f8564f133699a7"
},
"downloads": -1,
"filename": "adi_mkdocs_harmonic-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5ba534834cd44be3db11b6bd0348055",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 18305,
"upload_time": "2024-09-26T14:41:15",
"upload_time_iso_8601": "2024-09-26T14:41:15.799826Z",
"url": "https://files.pythonhosted.org/packages/b0/2f/5f74f298c7977a4771f53327e9c97df32fa875d7a937f78e11d19df944c6/adi_mkdocs_harmonic-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ceb738d4d0a1d48c5ab5b5f7578d4f6e27120b247de538a53f5438578b1acd11",
"md5": "64266ac7aecf6e817eb770129ed0d3eb",
"sha256": "8c1ef4b761cc534d8eaeb9d2caa918e14388160bad47bdc15b4d57fd9672d78b"
},
"downloads": -1,
"filename": "adi_mkdocs_harmonic-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "64266ac7aecf6e817eb770129ed0d3eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 16404,
"upload_time": "2024-09-26T14:41:16",
"upload_time_iso_8601": "2024-09-26T14:41:16.693880Z",
"url": "https://files.pythonhosted.org/packages/ce/b7/38d4d0a1d48c5ab5b5f7578d4f6e27120b247de538a53f5438578b1acd11/adi_mkdocs_harmonic-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 14:41:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "analogdevicesinc",
"github_project": "harmonic-mkdocs-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "adi-mkdocs-harmonic"
}
JSON
