MdMint

A free local Markdown workbench for writing, previewing, polishing, styling, presenting, and exporting documents.

MdMint is a browser-based Markdown and HTML workspace that runs locally. Open a Markdown file, write from scratch, preview the rendered document, tune the visual style, export polished deliverables, or print to PDF without sending your work to a hosted service.

It is designed for notes, reports, technical documents, meeting briefs, lightweight documentation, and shareable HTML packages.

Highlights

• Local Markdown editor with live preview, word count, line count, and document naming.
• HTML source studio for editing generated HTML directly when Markdown is not enough.
• Polished exports to Markdown, HTML, plain text, and interactive HTML.
• Print-ready output through the browser print dialog for PDF workflows.
• Slides and showcase modes for presenting a document without leaving the app.
• Theme and style controls for accent colors, backgrounds, tables, quotes, code blocks, and presets.
• Table tools for converting pasted rows into Markdown tables, sorting tables, and adding totals.
• Document helpers for spacing cleanup, table alignment, table of contents generation, report packs, and document health checks.
• Command palette for fast access to common actions.
• Optional local AI polishing through an OpenAI-compatible endpoint that you control.
• No build step required for normal use.

Quick Start

MdMint can run directly from the files in this repository.

1. Download or clone the project.
2. Open index.html in a modern browser.
3. Start writing in the Markdown pane.
4. Use the preview, design, export, print, and presentation tools from the toolbar.

For the simplest setup, double-click index.html or open it from your browser with File > Open File.

Optional Docker Usage

Docker is optional. Use it when you want to serve MdMint from a local web server instead of opening the HTML file directly.

docker compose up --build

Then open:

http://localhost:3060

To stop the container:

docker compose down

Usage Guide

Write And Preview

Use the left pane for Markdown and the right pane for live preview. MdMint supports common Markdown structures including headings, paragraphs, emphasis, links, blockquotes, lists, code fences, and tables.

The document name field controls suggested filenames when exporting or saving.

Import And Save

Use File > Import to open Markdown, text, or HTML files. Use the file menu to save the current document as:

• Markdown (.md)
• HTML (.html)
• Plain text (.txt)

Use Print / PDF to open the browser print dialog and save a PDF with your preferred system settings.

Edit HTML

Switch to Source view when you need to inspect or edit the generated HTML. MdMint can format HTML source, reset generated HTML from Markdown, and preview HTML changes alongside the editor.

Style Documents

Use Design view and the theme tools to adjust document appearance. MdMint includes presets such as Clean, Night, Ocean, Executive, and Warm, along with controls for page background, paper background, text, headings, borders, quote styling, table styling, and code styling.

Use Magic Tools

The Magic menu includes document-level helpers:

• Auto Design applies a clean visual treatment.
• Smart Polish improves Markdown spacing, heading flow, code fences, and table formatting.
• Build Report Pack adds a report-oriented structure.
• Add Table of Contents creates navigation for longer documents.
• Showcase Mode opens a full-window reading and presentation view.
• Make Slides turns document sections into slides.
• Document Health checks basic structure, navigation, tables, and length.
• Theme Gallery previews style presets.
• Smart Tables opens table conversion and cleanup tools.
• Interactive HTML exports a searchable, interactive HTML version.
• Command Palette opens quick command search.
• Local AI Polish can use a user-provided OpenAI-compatible endpoint.

Work With Tables

MdMint includes table-specific tools for practical Markdown editing:

• Convert selected CSV, tab-delimited, pipe-delimited, or spaced rows into a Markdown table.
• Sort a table by its first column.
• Add a totals row for numeric columns.
• Align existing Markdown tables for readability.

Present Documents

Use Showcase Mode for a full-window document view with print support. Use Make Slides to split content into slide-style sections with navigation, fit, and zoom controls.

Optional Local AI Polishing

MdMint can send the current Markdown document to a local OpenAI-compatible chat completions endpoint when you choose the local polishing command. This is optional and requires you to provide an endpoint and model name.

Use this only with a service you trust. MdMint does not require AI features for editing, previewing, exporting, styling, or presenting documents.

Privacy And Local-First Principles

MdMint is built to work locally:

• The core app is static HTML, CSS, and JavaScript.
• Normal editing, previewing, styling, table tools, exports, and printing happen in the browser.
• Document state and preferences may be stored in browser local storage.
• No account is required.
• No hosted backend is required.
• AI polishing is optional and only runs when you explicitly invoke it and provide an endpoint.

As with any browser app, imported files and saved exports are handled by your browser. Review your browser and operating system settings if you have strict file handling or privacy requirements.

Project Structure

.
├── README.md
├── ABOUT.md
├── index.html
├── app.js
├── styles.css
├── manifest.webmanifest
├── Dockerfile
├── docker-compose.yml
└── assets/
    └── brand/
        ├── mdmint-social-card.png
        ├── mdmint-logo-horizontal.png
        ├── mdmint-icon-192.png
        ├── mdmint-icon-512.png
        ├── favicon.ico
        ├── favicon-16.png
        ├── favicon-32.png
        └── apple-touch-icon.png

Browser Support

MdMint is intended for current desktop browsers. For best results, use a recent version of Chrome, Edge, Firefox, or Safari.

Browser print output, file saving behavior, and local file permissions can vary by browser and operating system.

Contributing

Contributions are welcome once contribution guidelines are published. Until then, keep proposed changes focused, public-safe, and easy to review.

Suggested contribution areas:

• Markdown rendering improvements
• Export and print polish
• Accessibility fixes
• Documentation improvements
• Browser compatibility fixes
• Table and presentation workflows

License

MdMint is released under the MIT License. See LICENSE for details.