mdterm

Render Markdown files as styled terminal output.

• Parses Markdown with Markdig and AngleSharp.
• Renders headings, paragraphs, links, code blocks, tables, and lists.
• Generates a table of contents from document headings.
• Uses a pager when available so long output is easier to browse.
• Ships release artifacts for Windows, Linux, and macOS.

Download a prebuilt archive from the latest release.

These are the package manager targets reflected by the repository's release automation and latest successful release workflow:

winget install fasterinnerlooper.mdterm
choco install mdterm
scoop bucket add fasterinnerlooper https://github.com/fasterinnerlooper/scoop-bucket
scoop install mdterm
paru -S mdterm
# or
yay -S mdterm

mdterm document.md
mdterm --mode ascii document.md
mdterm --list-styles
mdterm --help

Pass the path to a Markdown file and mdterm will render it directly in your terminal. Use --help to see the available CLI options in your installed build.

If you want to build, test, or contribute to mdterm, see CONTRIBUTING.md.

mdterm is a local CLI tool. It reads a Markdown file from disk and renders it in your terminal. The application code in this repository does not include telemetry, analytics, or outbound network calls for document rendering.

If you discover a vulnerability, use the private reporting process described in SECURITY.md.

This project is licensed under the MIT License.