Skip to content

What is MkDocs Publisher?

It is a set of plugins that extends MkDocs with a set of plugins, that help to create, edit and publish your content.

Why to use MkDocs Publisher?

Simple and powerful

Installation and configuration process is simple and fast. Also, most of the default settings is configured with simplicity in mind so you don't have to think about it and just start writing.

Share in social media

You can easily share link to your page on social media and customize it's image and description so it can help to attract new people.

Light and fast

Developed with both generation speed and smooth user experience build on top of best available component like MkDocs and Material for MkDocs.

Documentation structure

You can easily control documentation structure and visibility both for whole directories and single files right in your editor by adding some metadata directly in the document (no extra files need).

SEO optimized

Each page can be customized with its own creation date, URL and much more. Everything is easy to control right in your editor by adding some metadata directly in the document (no extra files need).

Size reduction

Documentation files and images can be minified to reduce their size and page load time (it also helps with SEO).

Obsidian integration

Obsidian as the documentation editor that can speed up your writing by using documents templates. You can also use this project alternatively to Obsidian Publish.

Your own blog

Sharing your knowledge or status over blog posts is always a great way of building a personal branding. Now creating posts directly from your documentation never been easier.

Logs on steroids

No matter if you are just an author or MkDocs plugin developer, it's easier to understand what's happening during documentation building. Now it's easier than ever before.

Open Source

Project is open source and distributed under MIT License, so you have full freedom to expand and use this project the way most convenient for you.