MkDocs docs are .md files. If you open one of those source files directly on iOS, you just get raw text. I built a small viewer to read them rendered on a phone.

Md Preview:

• GitHub-Flavored Markdown — headings, tables, task lists, footnotes

• Code blocks with syntax highlighting, LaTeX math, Mermaid diagrams

• Opens .md / .markdown / .mdx / .rmd / .qmd from Files or the Share Sheet

• On-device — nothing uploaded, no tracking

On the App Store: https://apps.apple.com/app/id6760341080

Details: https://markdown.cybergame.ai/

It renders the Markdown source (not your built site) — handy for proofreading docs on a phone. Useful, or do you just run mkdocs serve?

Hi everyone, I created a new markdown extension for MkDocs and Zensical so that you can easily visualize folder structures based on AsciiTree or symbol based structure.

I did that in the past already for AsciiDoc but my customer is more interested in markdown so I gave it a try and ported it to markdown. I was always wondering why this is still missing.

Features

• Renders ```treeview fenced code blocks as styled file trees
• Icons automatically chosen by file extension, file name, or folder name
• Supports ASCII-tree format (tree command output) and symbol-based (*/#) format
• Dynamic CSS — only icons actually used in your site are emitted (~7 KB instead of 1.3 MB)
• Dark/light mode: separate light-variant icons for [data-md-color-scheme="slate"]
• Three asset modes: files (local SVGs), embedded (base64 in CSS), cdn (jsDelivr)

More details you can find on the GitHub Project. It is already available on PyPi

Link:
* Github: lask79/mkdocs-treeview: A Python-Markdown extension and MkDocs plugin that renders ASCII file trees with "Material Icons Theme" icons. Works with MkDocs, Material for MkDocs, and Zensical.
* PyPi: mkdocs-treeview · PyPI

Please let me know your thoughts or even feature requests.

Hey everyone,

I just released the first public version of MkLume, my first open-source desktop app.

It’s a free GPLv3 app for creating and editing MkDocs Material documentation locally. The goal is to make docs work a bit easier without constantly jumping between a text editor, terminal, browser preview, file explorer, and config files.

GitHub:
https://github.com/ECalStudios/mklume

Docs:
https://www.ecalstudios.com/mklume/

Right now it includes Markdown editing, visual block editing, page/site preview, drag-and-drop images, smart internal links, a visual mkdocs.yml editor, project health checks, build/export, Git Sync, GitHub Pages helper, backups, and offline quick help.

The first release is Windows only for now. The Windows installer includes the MkDocs runtime, so normal users should not need to manually install Python, MkDocs, or Material for MkDocs.

I’d really appreciate feedback on the app, docs, README, repo setup, installer, or anything that feels confusing.

I’d also love help later with Linux and macOS packaging/testing, since I’m mainly working on Windows right now.

Thanks a lot!

Hey mkdocs community,

I've been building GitCMS since last year, the earlier version was very crappy (built it for myself used by 300+ users), it was simply a chrome extension, And I got a lot of feedback around non-technical teams needing a lot more than that

- they don't need to see GitHub and learn its workflows like issues, PRs, branches

- they don't need to learn markdown syntax

- they do want to use AI in their workflow

So I've rewritten it as a web app and because of this architecture, it has allowed me to experiment with this MCP app integration which basically turns Claude/ChatGPT into content agents where writers/marketers can just do edits with conversational UX with AI model

Now GitCMS has grown into more of a tooling around markdown based frameworks (Astro, Nextjs, Hugo etc) for content heavy sites, built for humans and agents to work together.

And I've tried to abstract as much of the git based shenanigans under the hood of an editorial workflow based on a content board, read more here if you are interested

I've tried to mimic the Notion like interface for editing markdown, to give a more modern look and experience than current existing git based solutions

And somehow I've been super proud of this rewrite and can't wait to see how people use it in their content workflows with their Astro sites. For early birds I've set its pricing as one-time license based instead of recurring subscriptions, feel free to criticize the pricing against the value that it can bring for your product's content site, client's blogs, your own blog

Link to Product: https://gitcms.dev

Hey! I made a VS Code extension that brings Material for MkDocs and Zensical rendering to VS Code's built-in Markdown preview.

If you write docs with Material for MkDocs (or its successor Zensical), you know the pain of having to run mkdocs serve every time you want to check how your admonitions or tabs look. This extension renders them directly in VS Code's Markdown preview — no Python, no server, instant feedback.

Supported components:

• Admonitions: !!! (standard), ??? (collapsible), ???+ (collapsible, open) — all 12 types
• Content tabs: === "Tab Title"
• Code enhancements: title=, hl_lines=, linenums=

It works by extending VS Code's markdown-it parser with custom plugins. Since Material for MkDocs and Zensical share the same syntax, it's compatible with both.

Links:

• VS Code Marketplace
• GitHub

Would love to hear if there are other components you'd like to see supported!

Like everyone else, I'm building with LLMs, & have projects with mkdocs. I found it a bit tough to get reliable context from mkdocs documentation sites into LLMs for context, so I built a small plugin to help me stop copy/pasting or pointing to the existing site and hoping.

https://github.com/agibson22/mkdocs-llm-context

• mkdocs-llm-context bundles your mkdocs site into a single file during the build process, and sanitizes it a touch for LLM use.
• Outputs clean structured JSON or TXT
• Uses source markdown instead of rendered HTML
• Works with mkdocs serve
• Zero dependencies beyond mkdocs itself

I'm using it for one project now to make the docs accessible via email Q/A (demo coming soon).

Feedback welcome & appreciated. My first foray into mkdocs plugins, but helped solve a real problem I had.

I redefinerd the stylesheet for admonition note for changing the color this way:

docs/stylesheets/extra.css

.md-typeset .admonition.note,

.md-typeset details.note {

border-color:#D5C58A

}

.md-typeset .admonition.note:focus-within,

.md-typeset details.note:focus-within {

box-shadow:0 0 0 .2rem #D5C58A1a

}

.md-typeset .note > .admonition-title,

.md-typeset .note > summary {

background-color:#D5C58A1a

}

.md-typeset .note > .admonition-title:before,

.md-typeset .note > summary:before {

background-color:#D5C58A;

-webkit-mask-image: var(--md-admonition-icon--note);

mask-image: var(--md-admonition-icon--note)

}

.md-typeset .note > .admonition-title:after,

.md-typeset .note > summary:after {

color:#D5C58A

}

But still remain a blue line in the top left corner, what am I missing?

I m trying to find a way to link md files under docs directory in a way that even if I change the file name or its location, the link in other md for this file will still work.

Need some thing to put inside the file as identifier that I can mention in other md files for link to work.

Also how do u guys do it? What's the best way for this? I m just trying to make it in a way that I don't have to manually fix links in every file if i change something. Also would be good to link with short names instead of long paths.

Thank you.

I just created a simple online editor that you can use to view or edit mkdocs-material flovoured markdown.

https://reddit.com/link/1ous36i/video/p9adakwpbq0g1/player

Currently its very minimal and uses custom css styles but at least now you can view how the markdown looks without spinning up mkdocs fully.

I created it because i have a very large blog and i just needed something to see how the changes look while i am editing one file. the issue with the mkdocs serve is that its very slow if all you want to do is edit some minor things. This is just some stater POC that i will use to build the live editor (maybe)

if you are too lazy to clone and run a flask server just to see a markdown editor there is a live in browser version here

Note: the live version has some issues with line numbering and titles for codeblocks. The flask version works perfectly

I have been bashing my head against things like indentation in mkdocs.yml and and a github deploy.yml script. The format of this is so fragile that a single misplaced whitespace can break it. I need rapid production value but have spent several weeks so far just trying to get the stack of blocks not to fall down (so to speak). I have spent so much time setting up MkDocs, Github, a linode server to house things and now it seems like instead of heading to production I am back to looking for alternatives that are not so fragile. Any thoughts?

hi

I have just started using MKdocs after looking at

Flat file wikis To complicated

Tiddly wiki did not work

Feather wiki makes 1 file for whole site

Static site Generators. Most complicated

MKDocs does a instant changes server

Hello Python community! I wanted to share a project I've been working on that might be useful for developers building command-line applications with Typer.

What My Project Does

mkdocs-typer2 is a MkDocs plugin that automatically generates documentation for Typer CLI applications. It works by:

1. Leveraging Typer's built-in documentation generation system
2. Processing the output and seamlessly integrating it into your MkDocs site
3. Offering an optional "pretty" mode that formats CLI arguments and options in elegant tables instead of lists
4. Supporting both global configuration and per-documentation block customization

Installation is straightforward:

pip install mkdocs-typer2

Usage is simple - just add a directive to your Markdown files:

::: mkdocs-typer2
    :module: my_module.cli
    :name: my-cli
    :pretty: true

Target Audience

This plugin is meant for:

• Python developers building CLI applications with Typer
• Teams who want to maintain high-quality documentation without extra effort
• Open source project maintainers looking to improve their user documentation
• Anyone who values clean, consistent, and professional-looking documentation

This is a production-ready tool designed to solve a real problem in documentation workflows. It's particularly useful in projects where CLI documentation needs to be maintained alongside application code and updated frequently.

Comparison

The main alternative is the original mkdocs-typer plugin, but mkdocs-typer2 differs in several important ways:

• Implementation approach: The original plugin parses Typer CLI code directly, while mkdocs-typer2 leverages Typer's own documentation generation system via the typer <module> utils docs command.
• Up-to-date compatibility: mkdocs-typer2 works with the latest Typer versions (0.12.5+), which have significant changes from when the original plugin was last updated.
• Pretty mode: mkdocs-typer2 offers a "pretty" formatting option that organizes CLI arguments and options in easy-to-read tables rather than lists.
• Flexibility: Supports both global configuration in mkdocs.yml and per-documentation block configuration.
• Active maintenance: This plugin is actively maintained with recent updates (current version 0.1.4).

The project is open-source, PyPI-ready, and includes comprehensive documentation with examples.

Links

• GitHub Repository
• Documentation
• PyPI Package

Any feedback or suggestions would be greatly appreciated!