# Publisher for MkDocs
[](https://opensource.org/license/mit/)
[](https://pypi.org/project/mkdocs-publisher/)
[](https://www.python.org)
[](https://pypistats.org/search/mkdocs-publisher)
[](https://github.com/mkusz/mkdocs-publisher/commits/main)
[](https://github.com/pre-commit/pre-commit)
Publisher for [MkDocs](https://www.mkdocs.org/) is a set of plugins that helps with content creation and publication.
## Features
- [pub-meta](https://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/setup/general/pub-obsidian/) – bindings for [Obsidina.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://mkusz.github.io/mkdocs-publisher/setup/seo-and-sharing/pub-social/) – social cards for social media sharing using document metadata,
- [pub-minifier](https://mkusz.github.io/mkdocs-publisher/setup/seo-and-sharing/pub-minifier/) – file size optimization (good for SEO and overall page size optimization),
- [pub-debugger](https://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/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/mkusz/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://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/development/changelog/) document and inside [releases](https://github.com/mkusz/mkdocs-publisher/releases).
Raw data
{
"_id": null,
"home_page": "https://mkusz.github.io/mkdocs-publisher",
"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/4d/64/932204e0d49653ea3b0c199b25b64bc405065d3c5026099a49cfd590349b/mkdocs_publisher-1.3.1.tar.gz",
"platform": null,
"description": "# Publisher for MkDocs\n\n[](https://opensource.org/license/mit/)\n[](https://pypi.org/project/mkdocs-publisher/)\n[](https://www.python.org)\n[](https://pypistats.org/search/mkdocs-publisher)\n[](https://github.com/mkusz/mkdocs-publisher/commits/main)\n[](https://github.com/pre-commit/pre-commit)\n\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://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/setup/general/pub-obsidian/) \u2013 bindings for [Obsidina.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://mkusz.github.io/mkdocs-publisher/setup/seo-and-sharing/pub-social/) \u2013 social cards for social media sharing using document metadata,\n- [pub-minifier](https://mkusz.github.io/mkdocs-publisher/setup/seo-and-sharing/pub-minifier/) \u2013 file size optimization (good for SEO and overall page size optimization),\n- [pub-debugger](https://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/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/mkusz/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://mkusz.github.io/mkdocs-publisher/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://mkusz.github.io/mkdocs-publisher/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.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/mkusz/mkdocs-publisher/issues",
"Documentation": "https://mkusz.github.io/mkdocs-publisher",
"Homepage": "https://mkusz.github.io/mkdocs-publisher",
"Repository": "https://github.com/mkusz/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": "16ab49006af5620572b5d54506aaaf7fdf5e638bbffa3369670906e9553cf1cb",
"md5": "4fc3a6facd6685e443c5001c23d0d2d7",
"sha256": "00fb989819d87fc38d7981bad00106eb99dfd757dd1c390338eaa833a0385172"
},
"downloads": -1,
"filename": "mkdocs_publisher-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fc3a6facd6685e443c5001c23d0d2d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 89354,
"upload_time": "2024-04-21T15:27:58",
"upload_time_iso_8601": "2024-04-21T15:27:58.954469Z",
"url": "https://files.pythonhosted.org/packages/16/ab/49006af5620572b5d54506aaaf7fdf5e638bbffa3369670906e9553cf1cb/mkdocs_publisher-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4d64932204e0d49653ea3b0c199b25b64bc405065d3c5026099a49cfd590349b",
"md5": "8c543ee2ccdb641e678c83a6a417f251",
"sha256": "4ef4cd1071725e5019d80e2a3835b185a4de14a975a05b167075635450f72f43"
},
"downloads": -1,
"filename": "mkdocs_publisher-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "8c543ee2ccdb641e678c83a6a417f251",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 43530,
"upload_time": "2024-04-21T15:28:00",
"upload_time_iso_8601": "2024-04-21T15:28:00.468911Z",
"url": "https://files.pythonhosted.org/packages/4d/64/932204e0d49653ea3b0c199b25b64bc405065d3c5026099a49cfd590349b/mkdocs_publisher-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 15:28:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mkusz",
"github_project": "mkdocs-publisher",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-publisher"
}
JSON
