Skip to content

Installation

MkLume 1.0.1 is currently distributed as a Windows desktop app. macOS and Linux packages are planned for a future release, and developers can build from source.

Windows installer

  1. Open the MkLume download page.
  2. Download MkLume_1.0.1_x64-setup.exe from the official GitHub release or from the download page.
  3. Run the installer.
  4. Open MkLume from the Start Menu.

Unsigned application

MkLume is not code-signed yet. Windows may show a SmartScreen warning because the publisher is unknown. This is common for new open-source desktop apps before code signing is set up. Use the official GitHub release and check the release checksum if you want to verify the file.

What works after installing

You can use MkLume right away for normal documentation work:

  • Create, open, edit, and organize documentation projects.
  • Use Markdown Mode, Visual Editor, Preview Mode, and Split View.
  • Manage navigation and common mkdocs.yml settings.
  • Drag and drop images into your docs.
  • Use internal link autocomplete.
  • Run Project Health checks.
  • Use autosave, backups, recovery drafts, and the command palette.
  • Build, export, and serve MkDocs sites using the bundled/app-managed runtime.
  • Generate GitHub Pages workflow files without giving MkLume any tokens.

Normal installer users do not need to install Python, MkDocs, Material for MkDocs, Node.js, Rust, or developer tools for everyday usage.

Optional: Git for Git Sync

Git Sync needs Git installed on your computer because MkLume uses your local Git setup.

Install Git for Windows, then restart MkLume if it was already open.

Git is usually installed through Xcode Command Line Tools:

xcode-select --install

Install Git through your package manager. For example, on Ubuntu/Debian:

sudo apt install git

Tip

Git is optional. You can use MkLume without Git if you prefer to upload files manually or use another workflow.

macOS and Linux

Native macOS and Linux packages are planned for a future release. Until then, developers can build MkLume from source.

Build from source

Use this only if you want to run or package MkLume as a developer.

Prerequisites

  • Node.js 18 or later
  • Rust stable
  • Platform build tools for Tauri

Steps

git clone https://github.com/ECalStudios/mklume.git
cd mklume
npm install
npx tauri dev

To create a release build:

npx tauri build

Check the repository README for the latest developer workflow.