{"id":17698497,"url":"https://github.com/pmeinhardt/maxdown","last_synced_at":"2025-12-25T00:21:34.394Z","repository":{"id":141524325,"uuid":"601205818","full_name":"pmeinhardt/maxdown","owner":"pmeinhardt","description":"for you @klappradla 👋","archived":false,"fork":false,"pushed_at":"2025-05-10T19:15:06.000Z","size":706,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-13T04:55:10.180Z","etag":null,"topics":["cli","html","markdown","neovim","preview","vim"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pmeinhardt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-13T15:31:08.000Z","updated_at":"2025-05-10T19:15:08.000Z","dependencies_parsed_at":"2023-10-01T16:07:28.607Z","dependency_job_id":"b0823b06-92fe-4a84-9dac-8508a77a1177","html_url":"https://github.com/pmeinhardt/maxdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fmaxdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fmaxdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fmaxdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fmaxdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pmeinhardt","download_url":"https://codeload.github.com/pmeinhardt/maxdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253877508,"owners_count":21977643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","html","markdown","neovim","preview","vim"],"created_at":"2024-10-24T15:09:22.536Z","updated_at":"2025-12-25T00:21:34.389Z","avatar_url":"https://github.com/pmeinhardt.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Maxdown 🚲\n\n[![checks](https://github.com/pmeinhardt/maxdown/actions/workflows/build.yml/badge.svg)](https://github.com/pmeinhardt/maxdown/actions/workflows/build.yml)\n\nMaxdown is a simple and fast Markdown-to-HTML converter. It comes with a command-line interface and an integration for (Neo)Vim.\n\n![](./media/banner.png)\n\n## Before you get going 🐿️\n\nYou will need [`cargo`](https://doc.rust-lang.org/cargo/index.html) in order to build the `maxdown` command-line tool.\n\nIn case you are using [Homebrew](https://brew.sh/), it should be as easy as `brew install rust`.\n\n## Installation 🪛\n\n### Command-line tool\n\nIf you're only interested in the `maxdown` command-line tool, you can build it by running:\n\n```shell\ncargo build --release --locked\n```\n\nThen, just put the resulting `target/release/maxdown` binary somewhere on your `PATH`.\n\n### Command-line tool via Homebrew\n\nAlternatively, you can install `maxdown`, built from source, via Homebrew:\n\n```shell\nbrew install --HEAD pmeinhardt/tools/maxdown\n```\n\nTo update, use:\n\n```shell\nbrew upgrade --fetch-HEAD pmeinhardt/tools/maxdown\n```\n\n### Vim plugin\n\nFor the Vim plugin, if you use [vim-plug](https://github.com/junegunn/vim-plug), add this line to your Vim configuration file:\n\n```vim\nPlug 'pmeinhardt/maxdown', {'do': ':MaxdownCompile'}\n```\n\nIf you have a different way of managing your Vim plugins, make sure you add the project directory to your `runtimepath` and build the command-line tool:\n\n```sh\ncargo build --release --locked\n```\n\nOr, to build from within Vim:\n\n```\n:MaxdownCompile\n```\n\n## Usage ⌨️\n\n### Command-line tool\n\nThe `maxdown` command-line tool reads Markdown from `stdin` or a file and outputs HTML to `stdout` or a file.\n\nFor instance:\n\n```sh\necho 'Hello *World*!' | maxdown\nmaxdown README.md\n```\n\nTo learn about the extra knobs and switches, kindly ask `maxdown` for help:\n\n```\n$ maxdown --help\nConvert Markdown to HTML\n\nUsage: maxdown [OPTIONS] [PATH]\n\nArguments:\n  [PATH]  Path to the input Markdown file [default: stdin]\n\nOptions:\n  -b, --base \u003curl\u003e       Base URL to use for all relative URLs in the document\n      --dangerous        Only use this if you trust the authors of the document\n  -o, --output \u003cpath\u003e    File to write output to [default: stdout]\n  -t, --template \u003cpath\u003e  Template to use for output [default: built-in template]\n      --title \u003ctitle\u003e    Title to pass to the template [default: Preview]\n  -h, --help             Print help\n  -V, --version          Print version\n```\n\n### Vim plugin\n\nTo preview the current markdown buffer, invoke `:MaxdownPreview`.\n\n Alternatively, define a custom mapping. For instance:\n\n```vim\nautocmd FileType markdown nnoremap \u003cbuffer\u003e \u003clocalleader\u003em \u003cPlug\u003eMaxdownPreview\n```\n\nThis will create a normal-mode mapping to preview the current markdown buffer.\n\nTo replace the current Markdown buffer's content with the corresponding HTML, use `:MaxdownConvert`.\n\nIf you have other use cases, you always have the option of defining your own custom commands and mappings using the command-line tool.\n\n## Enhancements 🪄\n\nWith the `ql` [Vim plugin](https://github.com/pmeinhardt/ql), previews on macOS will look more neat (no `[DEBUG]` in the title):\n\n```vim\nPlug 'pmeinhardt/ql', {'do': ':QuickLookCompile'}\n```\n\n## Thanks ❤️\n\nMaxdown is built on top of the impressive work of other people:\n\n- markdown-rs: https://github.com/wooorm/markdown-rs\n- minijinja: https://github.com/mitsuhiko/minijinja\n- clap: https://github.com/clap-rs/clap\n- trycmd: https://github.com/assert-rs/trycmd\n- github-markdown-css: https://github.com/sindresorhus/github-markdown-css\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmeinhardt%2Fmaxdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpmeinhardt%2Fmaxdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmeinhardt%2Fmaxdown/lists"}