Skip to content

Changelog

1.0.1 — Visual editor polish update

MkLume 1.0.1 is a focused patch for the parts people notice while writing real documentation: Visual Mode rendering, cards, images, and icons. It does not change the Markdown format and it does not change how the bundled/app-managed MkDocs runtime works.

Improved

  • Improved Visual Mode rendering for MkDocs Material card grids.
  • Added real image thumbnail rendering in Visual Mode when image paths can be resolved from the project.
  • Improved card image fit and cropping so cards feel closer to the final MkDocs Material output.
  • Improved rendering of inline links and images inside visual cards.
  • Improved spacing for card descriptions and link rows.
  • Improved Preview rendering for card descriptions.
  • Improved icon shortcode rendering in Visual Mode and Preview Mode.
  • Improved Visual Mode block action button visibility in dark mode.

Added

  • Added icon insertion through the Insert menu in Visual Mode.
  • Added icon insertion through the Visual Mode slash command.
  • Added a cleaner fallback display for unsupported icons.

Cleaned up

  • Removed old temporary icon-generation scripts from the source package.

1.0.0 — First public release

Initial public release of MkLume.

Editing

  • Markdown Mode with toolbar, keyboard shortcuts, and Insert menu for Material components.
  • Visual Editor with rich block support, including admonitions, content tabs, grid cards, and tables.
  • Page Preview with rendered Markdown, images, and Material-style layout.
  • Site Preview for checking the broader documentation structure.
  • Flexible Split View with editor/preview combinations.
  • Find and Replace in Markdown Mode.
  • Smart internal link autocomplete.
  • Drag-and-drop image handling with automatic copy into the project assets folder.

Project management

  • Site Settings editor for common mkdocs.yml values.
  • Navigation editor with add/remove pages, sections, and reordering.
  • Project Health scanner for broken links, missing images, navigation issues, extensions, and SEO basics.
  • Extras & Integrations panel for analytics, social links, consent, and optional MkLume credit.

Build and deploy

  • Build to folder, ZIP, or both.
  • Bundled/app-managed MkDocs runtime for installed Windows builds.
  • MkDocs Serve for local browser preview.
  • Git Sync for commit/push workflows, using the user's local Git installation.
  • GitHub Pages Deploy Assistant that generates workflow files without requesting tokens.

Reliability

  • Autosave with configurable delay.
  • Backup before save with timestamped copies.
  • Recovery drafts for crash protection.
  • Command Palette.
  • Light and Dark mode with system preference support.

Help and documentation

  • Offline Quick Help bundled with the app.
  • Online documentation at www.ecalstudios.com/mklume/.
  • Public GitHub repository with issue templates.