View a Markdown file as a rendered HTML page, in a browser that runs inside your terminal.

You need Rust and terminal-browser.

1. Install: cargo install --git https://github.com/slara/terminal-markdown-renderer
2. Open a file beside your shell: tmdview README.md --split right
3. Add --watch to reload the page each time you save the file.

To close the browser pane, press Ctrl+Q or Ctrl+C inside it.

tmdview notes.md                      # the browser takes over this pane
tmdview notes.md -s right -w          # open beside this pane, reload on save
tmdview notes.md -s down --size 0.4   # a smaller pane below
tmdview notes.md -t dark              # force the dark theme
tmdview notes.md --no-open -o out.html  # only write the HTML file

• GitHub-flavored Markdown: tables, task lists, footnotes, strikethrough
• Code blocks with syntax colors, in light and dark themes
• Links to headings (#usage), including headings you give a custom {#id}
• Relative links and images, resolved from the Markdown file's folder

Math is recognized but shown as plain text, not typeset.

tmdview turns the Markdown into a single HTML file, then asks terminal-browser to open it. With --watch, it checks the file 4 times a second, rebuilds the page on change and reloads that one tab.

docs/ARCHITECTURE.md explains the modules, the data flow and the design choices.

cargo test      # unit tests, no browser needed
cargo clippy --all-targets
cargo run -- README.md --split right --watch

The browser code is only tested by hand, because it needs a running terminal-browser.

Licensed under either of these, at your option:

• Apache License, Version 2.0 (LICENSE-APACHE)
• MIT license (LICENSE-MIT)

Unless you say otherwise, any contribution you submit for inclusion in this work, as defined in the Apache-2.0 license, is dual licensed as above, with no extra terms or conditions.