https://github.com/timmeinerzhagen/mkdocs-meta-manager

MkDocs plugin for managing meta tags across folders and files
https://github.com/timmeinerzhagen/mkdocs-meta-manager

meta mkdocs tags

Last synced: 2 months ago
JSON representation

MkDocs plugin for managing meta tags across folders and files

• Host: GitHub
• URL: https://github.com/timmeinerzhagen/mkdocs-meta-manager
• Owner: timmeinerzhagen
• License: mit
• Created: 2022-12-11T16:38:21.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-09T20:02:47.000Z (8 months ago)
• Last Synced: 2024-11-01T23:42:22.523Z (2 months ago)
• Topics: meta, mkdocs, tags
• Language: Python
• Homepage: https://pypi.org/project/mkdocs-meta-manager/
• Size: 42 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-meta-manager

MkDocs plugin for managing meta tags across folders and files

## Setup

1. Install the plugin:

    ```bash

    pip install mkdocs-meta-manager

    ```

2. Add the plugin to your `mkdocs.yml`

    ```bash

    plugins:

        - search

        - meta-manager

    ```

## Usage

Add meta files with the name `.meta.yml` (can be configured) in your docs file structure.

All markdown files in the same folder and in subfolders automatically get all tags that are defined in the given meta file.

## Options

`meta_filename`

Change the default name of the meta file. (default=`.meta.yml`)

`merge_entries`

Merge all specified entries of meta files and pages for a page that affects them according to the hirearchie (default=`[]`)