mkdocs-plugin-tags 1.0.2
"Create tags in mkdocs"
License: MIT
Requires Python: >=3.6
Keywords: "mkdocs python markdown tags"

# Tags

Support for tags in the yaml-metadata in the header of markdown files.

Extracts this metadata and creates a "Tags" page which lists all tags
and all pages for each tag.

## Quick Demo

Install this plugin (it will also install mkdocs if required)

```bash
pip install mkdocs-plugin-tags
```

Create a new documentation folder:

```bash
mkdocs new demo
```

Edit the `.md` files to add initial metadata. Currently, the metadata has to be
enclosed in `---` lines, and must include a `title:` property
(otherwise the page will appear as "untitled" in the tags page). So, for example:

```bash
cd demo
cd docs
cat > index.md
---
title: Welcome
tags:
 - testing
 - unimportant
---
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://mkdocs.org).

^D
```

Edit `mkdocs.yml` to include this plugin:

```yaml
plugins:
  - tags:
```

Run the server:

```bash
mkdocs serve --livereload
```

Visit the URL `/tags` (it should appear in the nav panel).
This is an auto-generated page which contains the tags as level 2 headers,
and under each tag, a listing of the pages which declare that tag in the
metadata section.

![example screenshot](doc/imgs/screenshot.png)

## How it works

On each build (even with `--livereload`), all the `.md` files composing the
site are scanned, their "triple-dash-delimted" yaml header is extracted and
parsed, and the list of tags is collected.

After that, a new temporal file is created (by default in `aux/tags.md`, but
this is customizable) which contains the generated tags page, in markdown
format. This file is not in the documents folder to avoid retriggering a
build, but it is added to the list of files to be converted to HTML by mkdocs.

## Customization

The layout of the tags page is a markdown file with jinja2 embedded contents.
The package provides such a template by default, with the following content:

```markdown
---
title: Tags
---
# Contents grouped by tag

{% for tag, pages in tags %}

## <span class="tag">{{tag}}</span>
{%  for page in pages %}
  * [{{page.title}}]({{page.filename}})
{% endfor %}

{% endfor %}
```

You can style the `h2.tag` element via CSS, if you want.

You can also provide your own markdown template, in case that you want a
different layout or metadata. The `page` object contains all the metadata
in a mkdocs page, and in addition a `.filename` attribute, which contains
the file name of the source of the page (relative to the docs folder),
which can be used to link to that page.

The full customizable options for the plugin are:

* `tags_folder`: Folder in which the auxiliar tags markdown file will be written
  (`aux` by default, relative to the folder in which `mkdocs` is invoked).
  It can be set to an absolute path, such as `/tmp/mysite/aux`.
  The required folders are created.
* `tags_template`: path to the file which contains the markdown-jinja template
  for the tags page. It is `None` by default, which means that the
  package-provided template is used. It can be an absolute path,
  or relative to the folder in which `mkdocs` is run.
* `css_name`: this allows you to pick what name styles the tag that appears on
  the top of the page that contains a tag. This way things won't be overloaded

For example, this can be put at `mkdocs.yaml`:

```yaml
plugins:
    - search
    - tags:
        tags_folder: /tmp/mysite/aux
        tags_template: docs/theme/tags.md.template
```