Skip to content

MkLume

MkLume is a free, open-source desktop editor for creating and maintaining MkDocs Material documentation.

It is built for people who want the power of MkDocs without doing every small task by hand. You can write pages, organize navigation, manage site settings, preview your docs, check project health, and build/export the final static site from one focused workspace.

MkLume is local-first: your files stay in your project folder, there are no accounts, no cloud lock-in, and no subscription.

MkLume welcome screen

Best for: app documentation, plugin manuals, small studio websites, internal knowledge bases, indie tool docs, and any MkDocs Material project that needs a friendlier editing workflow.

Download Get started GitHub

What MkLume helps with

  • Write without friction

    Work in Visual Editor, Markdown Mode, Preview Mode, or Split View depending on what feels better for the page you are editing.

  • Keep full Markdown control

    Use raw Markdown whenever you need exact formatting, MkDocs Material blocks, admonitions, tabs, tables, or code examples.

  • Handle images faster

    Drag images into your documentation, copy them into the project assets folder, and insert Markdown references without repetitive file work.

  • Create internal links more easily

    Link to other pages in the project without memorizing every path.

  • Edit navigation visually

    Manage the structure of your docs from a navigation editor instead of doing everything inside mkdocs.yml by hand.

  • Adjust site settings

    Update common MkDocs Material settings through panels for identity, theme, navigation, extras, analytics, and more.

  • Catch common problems

    Use Project Health to spot broken links, missing images, navigation issues, extension problems, and SEO basics before publishing.

  • Build and export

    Build to a folder, export a ZIP, or do both. The Windows installer includes an app-managed MkDocs runtime, so normal users do not need to install Python or MkDocs separately.

Current release

Item Status
Version 1.0.1
License GPLv3
Source code ECalStudios/mklume
Issues and support GitHub Issues
Windows Installer available from the download page and GitHub Releases
macOS Planned for a future package; developers can build from source
Linux Planned for a future package; developers can build from source

What changed in 1.0.1

MkLume 1.0.1 improves the Visual Editor experience for MkDocs Material card grids, image thumbnails, card spacing, icon shortcodes, and dark-mode block controls. It is a safe polish update with no Markdown format changes.

Windows SmartScreen

MkLume is not code-signed yet. Windows may show an unknown publisher warning the first time you run it. Use the official GitHub release download and verify the checksum from the release page if you want an extra safety check.

A normal workflow

  1. Create a new MkDocs project or open an existing one.
  2. Write pages in Visual Editor or Markdown Mode.
  3. Add images, internal links, and navigation entries.
  4. Preview the current page or the full site.
  5. Run Project Health before publishing.
  6. Build/export the final site and upload it wherever you host your docs.