Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkdocs-publisher/mkdocs-publisher
Publisher for MkDocs - a set of plugins for content creators
https://github.com/mkdocs-publisher/mkdocs-publisher
blog blogging callouts debugger metadata minification mkdocs mkdocs-plugins obsidian obsidian-md obsidian-vault publishing roam-research roamresearch
Last synced: 3 days ago
JSON representation
Publisher for MkDocs - a set of plugins for content creators
- Host: GitHub
- URL: https://github.com/mkdocs-publisher/mkdocs-publisher
- Owner: mkdocs-publisher
- License: mit
- Created: 2023-02-02T15:47:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T14:15:31.000Z (7 days ago)
- Last Synced: 2024-12-25T19:48:21.440Z (6 days ago)
- Topics: blog, blogging, callouts, debugger, metadata, minification, mkdocs, mkdocs-plugins, obsidian, obsidian-md, obsidian-vault, publishing, roam-research, roamresearch
- Language: Python
- Homepage: https://mkdocs-publisher.github.io/
- Size: 8.32 MB
- Stars: 70
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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://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).