mkdocs-publisher


Namemkdocs-publisher JSON
Version 1.4.6 PyPI version JSON
download
home_pagehttps://mkdocs-publisher.github.io/
SummaryPublisher for MkDocs - set of plugins for content creators
upload_time2025-02-07 11:31:44
maintainerNone
docs_urlNone
authorMaciej 'maQ' Kusz
requires_python<4.0,>=3.9
licenseMIT
keywords mkdocs mkdocs-plugin blog categories debugger docs documentation frontmatter markdown minifier navigation obsidian publisher tags
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Publisher for MkDocs

[![License type](https://img.shields.io/github/license/mkdocs-publisher/mkdocs-publisher?logo=pypi&logoColor=white&style=plastic&label=License)](https://opensource.org/license/mit/)
[![PyPI version](https://img.shields.io/pypi/v/mkdocs-publisher?logo=pypi&logoColor=white&style=plastic&label=PyPi)](https://pypi.org/project/mkdocs-publisher/)
[![PyPI - Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmkdocs-publisher%2Fmkdocs-publisher%2Fmain%2Fpyproject.toml&query=%24.tool.poetry.dependencies.python&logo=python&logoColor=white&style=plastic&label=Python)](https://www.python.org)
[![PyPI Downloads last month](https://img.shields.io/pypi/dm/mkdocs-publisher?logo=pypi&logoColor=white&style=plastic&label=Downloads)](https://pypistats.org/search/mkdocs-publisher)
[![GitHub last commit](https://img.shields.io/github/last-commit/mkdocs-publisher/mkdocs-publisher?logo=github&logoColor=white&style=plastic&label=Last%20commit)](https://github.com/mkusz/mkdocs-publisher/commits/main)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=plastic&label=Pre-commit)](https://github.com/pre-commit/pre-commit)
![Code Coverage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmkdocs-publisher%2Fmkdocs-publisher%2Fmain%2Fcov.json&query=%24.percent_covered_display&suffix=%25&color=green&style=plastic&label=Code%20coverage)

Publisher for [MkDocs](https://www.mkdocs.org/) is a set of plugins that helps with content creation and publication.

## Features

- [pub-meta](https://mkdocs-publisher.github.io/setup/general/pub-meta/) – support for:
	- automatic [document navigation](https://www.mkdocs.org/user-guide/configuration/#nav) creation based on file names order,
	- document publication status,
	- possibility to define document and directories URL (good for SEO),
	- document creation and update date (good for SEO),
- [pub-blog](https://mkdocs-publisher.github.io/setup/general/pub-blog/) – blogging capability:
	- index creation,
	- support for blog post teasers,
	- automatic creation of pages for archive, categories and tags,
- [pub-obsidian](https://mkdocs-publisher.github.io/setup/general/pub-obsidian/) – bindings for [Obsidian.md](https://obsidian.md) that allows you to use:
	- [backlinks](https://help.obsidian.md/Plugins/Backlinks),
	- [callouts](https://help.obsidian.md/Editing+and+formatting/Callouts),
	- [wikilinks](https://help.obsidian.md/Linking+notes+and+files/Internal+links),
	- [vega charts](https://vega.github.io/vega/) (using [Vega Visualization Plugin for Obsidian](https://github.com/Some-Regular-Person/obsidian-vega)) - advanced solution for creating charts,
- [pub-social](https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-social/) – social cards for social media sharing using document metadata,
- [pub-minifier](https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-minifier/) – file size optimization (good for SEO and overall page size optimization),
- [pub-debugger](https://mkdocs-publisher.github.io/setup/development/pub-debugger/) – logging on steroids with the possibility of creating of ZIP file with logs and additional information (can be used for better issue reporting).

## Installation

```commandline
pip install mkdocs-publisher
```

More information about installation methods and plugin setup can be found on this [documentation page](https://mkdocs-publisher.github.io/setup/installation/).

> [!warning]
> Before any use, make sure you have a backup of your data.

> [!note]
> As a base for any development, [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme was used. If you are willing to use any other theme, you may (or may not) face some issues. If this happens, please submit an [issue](https://github.com/mkdocs-publisher/mkdocs-publisher/issues).

After installation, you have to enable plugins and Material for MkDocs theme in `mkdocs.yml` file:

```yaml
theme: material

plugins:
  - search  # Material for MkDocs search plugin
  - pub-debugger
  - pub-blog
  - pub-obsidian
  - pub-social
  - pub-meta
  - pub-minifier
```

## Planned features

A full list of planned developments can be found on [this documentation page](https://mkdocs-publisher.github.io/development/other/backlog/). I'm planning to move it to the project [GitHub issues](https://github.com/mkusz/mkdocs-publisher/issues) with proper badges and longer descriptions, but it's time-consuming and at this stage I'd rather spend it developing a project.

## Version history

The entire version history can be found in the project [version history](https://mkdocs-publisher.github.io/development/changelog/) document and inside [releases](https://github.com/mkusz/mkdocs-publisher/releases).

Raw data

            {
    "_id": null,
    "home_page": "https://mkdocs-publisher.github.io/",
    "name": "mkdocs-publisher",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "mkdocs, mkdocs-plugin, blog, categories, debugger, docs, documentation, frontmatter, markdown, minifier, navigation, obsidian, publisher, tags",
    "author": "Maciej 'maQ' Kusz",
    "author_email": "maciej.kusz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5c/0b/91efe92d593bf9e2953d6cdd7c6f77f4717dcb8221a37810796775c3b8aa/mkdocs_publisher-1.4.6.tar.gz",
    "platform": null,
    "description": "# Publisher for MkDocs\n\n[![License type](https://img.shields.io/github/license/mkdocs-publisher/mkdocs-publisher?logo=pypi&logoColor=white&style=plastic&label=License)](https://opensource.org/license/mit/)\n[![PyPI version](https://img.shields.io/pypi/v/mkdocs-publisher?logo=pypi&logoColor=white&style=plastic&label=PyPi)](https://pypi.org/project/mkdocs-publisher/)\n[![PyPI - Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmkdocs-publisher%2Fmkdocs-publisher%2Fmain%2Fpyproject.toml&query=%24.tool.poetry.dependencies.python&logo=python&logoColor=white&style=plastic&label=Python)](https://www.python.org)\n[![PyPI Downloads last month](https://img.shields.io/pypi/dm/mkdocs-publisher?logo=pypi&logoColor=white&style=plastic&label=Downloads)](https://pypistats.org/search/mkdocs-publisher)\n[![GitHub last commit](https://img.shields.io/github/last-commit/mkdocs-publisher/mkdocs-publisher?logo=github&logoColor=white&style=plastic&label=Last%20commit)](https://github.com/mkusz/mkdocs-publisher/commits/main)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=plastic&label=Pre-commit)](https://github.com/pre-commit/pre-commit)\n![Code Coverage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmkdocs-publisher%2Fmkdocs-publisher%2Fmain%2Fcov.json&query=%24.percent_covered_display&suffix=%25&color=green&style=plastic&label=Code%20coverage)\n\nPublisher for [MkDocs](https://www.mkdocs.org/) is a set of plugins that helps with content creation and publication.\n\n## Features\n\n- [pub-meta](https://mkdocs-publisher.github.io/setup/general/pub-meta/) \u2013 support for:\n\t- automatic [document navigation](https://www.mkdocs.org/user-guide/configuration/#nav) creation based on file names order,\n\t- document publication status,\n\t- possibility to define document and directories URL (good for SEO),\n\t- document creation and update date (good for SEO),\n- [pub-blog](https://mkdocs-publisher.github.io/setup/general/pub-blog/) \u2013 blogging capability:\n\t- index creation,\n\t- support for blog post teasers,\n\t- automatic creation of pages for archive, categories and tags,\n- [pub-obsidian](https://mkdocs-publisher.github.io/setup/general/pub-obsidian/) \u2013 bindings for [Obsidian.md](https://obsidian.md) that allows you to use:\n\t- [backlinks](https://help.obsidian.md/Plugins/Backlinks),\n\t- [callouts](https://help.obsidian.md/Editing+and+formatting/Callouts),\n\t- [wikilinks](https://help.obsidian.md/Linking+notes+and+files/Internal+links),\n\t- [vega charts](https://vega.github.io/vega/) (using [Vega Visualization Plugin for Obsidian](https://github.com/Some-Regular-Person/obsidian-vega)) - advanced solution for creating charts,\n- [pub-social](https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-social/) \u2013 social cards for social media sharing using document metadata,\n- [pub-minifier](https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-minifier/) \u2013 file size optimization (good for SEO and overall page size optimization),\n- [pub-debugger](https://mkdocs-publisher.github.io/setup/development/pub-debugger/) \u2013 logging on steroids with the possibility of creating of ZIP file with logs and additional information (can be used for better issue reporting).\n\n## Installation\n\n```commandline\npip install mkdocs-publisher\n```\n\nMore information about installation methods and plugin setup can be found on this [documentation page](https://mkdocs-publisher.github.io/setup/installation/).\n\n> [!warning]\n> Before any use, make sure you have a backup of your data.\n\n> [!note]\n> As a base for any development, [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme was used. If you are willing to use any other theme, you may (or may not) face some issues. If this happens, please submit an [issue](https://github.com/mkdocs-publisher/mkdocs-publisher/issues).\n\nAfter installation, you have to enable plugins and Material for MkDocs theme in `mkdocs.yml` file:\n\n```yaml\ntheme: material\n\nplugins:\n  - search  # Material for MkDocs search plugin\n  - pub-debugger\n  - pub-blog\n  - pub-obsidian\n  - pub-social\n  - pub-meta\n  - pub-minifier\n```\n\n## Planned features\n\nA full list of planned developments can be found on [this documentation page](https://mkdocs-publisher.github.io/development/other/backlog/). I'm planning to move it to the project [GitHub issues](https://github.com/mkusz/mkdocs-publisher/issues) with proper badges and longer descriptions, but it's time-consuming and at this stage I'd rather spend it developing a project.\n\n## Version history\n\nThe entire version history can be found in the project [version history](https://mkdocs-publisher.github.io/development/changelog/) document and inside [releases](https://github.com/mkusz/mkdocs-publisher/releases).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Publisher for MkDocs - set of plugins for content creators",
    "version": "1.4.6",
    "project_urls": {
        "Bug Tracker": "https://github.com/mkdocs-publisher/mkdocs-publisher/issues",
        "Documentation": "https://mkdocs-publisher.github.io/",
        "Homepage": "https://mkdocs-publisher.github.io/",
        "Repository": "https://github.com/mkdocs-publisher/mkdocs-publisher"
    },
    "split_keywords": [
        "mkdocs",
        " mkdocs-plugin",
        " blog",
        " categories",
        " debugger",
        " docs",
        " documentation",
        " frontmatter",
        " markdown",
        " minifier",
        " navigation",
        " obsidian",
        " publisher",
        " tags"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3b11024f1df6b060c8171f9a7f0376065c861238376a0fa45edf36f061eb8ef",
                "md5": "b3fee99a744bcfa0e9ae096eaf1a9a5e",
                "sha256": "c1f23a8f0ed98536bc55fcf24c26f6a9606d1f8f3471c70776ca35c4d4668d09"
            },
            "downloads": -1,
            "filename": "mkdocs_publisher-1.4.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b3fee99a744bcfa0e9ae096eaf1a9a5e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 92301,
            "upload_time": "2025-02-07T11:31:42",
            "upload_time_iso_8601": "2025-02-07T11:31:42.286479Z",
            "url": "https://files.pythonhosted.org/packages/d3/b1/1024f1df6b060c8171f9a7f0376065c861238376a0fa45edf36f061eb8ef/mkdocs_publisher-1.4.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c0b91efe92d593bf9e2953d6cdd7c6f77f4717dcb8221a37810796775c3b8aa",
                "md5": "79b30fd550e8b9b154afd6fdaf9b9ca7",
                "sha256": "77533a12e3619e3681e2d427aea2fce057c8759e6e42184af59c4d544e871f70"
            },
            "downloads": -1,
            "filename": "mkdocs_publisher-1.4.6.tar.gz",
            "has_sig": false,
            "md5_digest": "79b30fd550e8b9b154afd6fdaf9b9ca7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 44872,
            "upload_time": "2025-02-07T11:31:44",
            "upload_time_iso_8601": "2025-02-07T11:31:44.394431Z",
            "url": "https://files.pythonhosted.org/packages/5c/0b/91efe92d593bf9e2953d6cdd7c6f77f4717dcb8221a37810796775c3b8aa/mkdocs_publisher-1.4.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-07 11:31:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mkdocs-publisher",
    "github_project": "mkdocs-publisher",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-publisher"
}
Maciej 'maQ' Kusz
Elapsed time: 0.45465s