{"id":17309960,"url":"https://github.com/metafates/marky","last_synced_at":"2025-04-14T13:32:31.019Z","repository":{"id":65567128,"uuid":"594731070","full_name":"metafates/marky","owner":"metafates","description":"🏭 Convert Markdown documents into themed HTML pages with support for code syntax highlighting, LaTeX and Mermaid diagrams.","archived":false,"fork":false,"pushed_at":"2023-07-20T16:42:48.000Z","size":530,"stargazers_count":29,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T03:01:41.828Z","etag":null,"topics":["cli","markdown","markdown-to-html","notes","pdf","rust"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/marky","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/metafates.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-01-29T13:27:08.000Z","updated_at":"2025-03-04T00:33:22.000Z","dependencies_parsed_at":"2024-03-02T02:01:21.284Z","dependency_job_id":null,"html_url":"https://github.com/metafates/marky","commit_stats":{"total_commits":32,"total_committers":2,"mean_commits":16.0,"dds":0.03125,"last_synced_commit":"fe6295ceeabca33d3bf700576fb95f32a42b6f24"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metafates%2Fmarky","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metafates%2Fmarky/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metafates%2Fmarky/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metafates%2Fmarky/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metafates","download_url":"https://codeload.github.com/metafates/marky/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248888778,"owners_count":21178103,"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","markdown","markdown-to-html","notes","pdf","rust"],"created_at":"2024-10-15T12:34:08.283Z","updated_at":"2025-04-14T13:32:30.999Z","avatar_url":"https://github.com/metafates.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Marky\n\nMarkdown Magician 🧙\n\n**Features**\n\n- Hot reload previewing 🔥\n- Conversion to **HTML**  🏭\n- Themes! ✨\n- Extensions - Math, diagrams, syntax-highlighting 🧩\n- Download base64 encoded images (png, jpg, svg)\n\n\u003c!--toc:start--\u003e\n\n- [Examples](#examples)\n- [Install](#install)\n- [Help](#help)\n- [Build](#build)\n- [Screenshots](#screenshots)\n\n\u003c!--toc:end--\u003e\n\n## Examples\n\nConvert `doc.md` to `doc.html`\n\n```bash\nmarky doc.md\n```\n\nStart a local preview server with hot-reload\n\n```bash\nmarky doc.md --live\n```\n\nEnable extensions\n\n```bash\n# Or use --all to enable all\nmarky doc.md --math --diagrams --highlight\n```\n\nInclude local images as base64 encoded and compress them (beta)\n\n```bash\n# possible values: local, remote, all\nmarky doc.md --include-images \"local\" --optimize-images\n# or short\nmarky doc.md -zI local\n```\n\nSelect and use a different theme with fzf\n\n```bash\nmarky doc.md --theme $(marky --themes | fzf)\n```\n\nPipe from stdout and open compiled file\n\n```bash\ncat doc.md | marky --out doc.html --open\n```\n\n\u003e See `--help` for more info\n\n## Install\n\nInstall using [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)\n\n```bash\ncargo install marky\n```\n\n## Help\n\n```\nMarkdown Magician 🧙\n\nUsage: marky [OPTIONS] [PATH]\n\nArguments:\n  [PATH]  Read input from file\n\nOptions:\n      --completion \u003cGENERATOR\u003e\n          [possible values: bash, elvish, fish, powershell, zsh]\n  -t, --theme \u003cTHEME\u003e\n          Theme to use\n      --string \u003cSTRING\u003e\n          Read input from string\n      --themes\n          List available themes\n      --where-config\n          Print config path\n  -o, --out \u003cOUT\u003e\n          Output file\n      --stdout\n          Output to stdout\n  -H, --highlight\n          Enable syntax highligting with highlight.js\n  -M, --math\n          Enable math rendering with KaTeX\n  -D, --diagrams\n          Enable UML diagrams rendering with Mermaid\n  -I, --include-images \u003cINCLUDE_IMAGES\u003e\n          Include images into file as base64 encoded [possible values: local, remote, all]\n  -z, --optimize-images\n          Optimize included images to make them smaller\n  -A, --all\n          Enable all extra renderers\n  -w, --watch\n          Recompile file on save\n  -l, --live\n          Live preview in the browser\n      --port \u003cPORT\u003e\n          Port of the live server [default: 8080]\n  -O, --open\n          Open output file in the default app\n  -h, --help\n          Print help\n  -V, --version\n          Print version\n```\n\n## Build\n\n```bash\ngit clone https://github.com/metafates/marky.git\ncd marky\ncargo install --path .\n```\n\n## Screenshots\n\nSome examples...\n\n```bash\nmarky README.md --theme sakura # default theme\n```\n\n![sakura](https://user-images.githubusercontent.com/62389790/216391306-ecd73229-6342-4a79-8f7f-5f632a231a6f.png)\n\n```bash\nmarky README.md --theme air\n```\n\n![air](https://user-images.githubusercontent.com/62389790/216391415-46ca090a-801d-423e-a523-dc3e59ed1f77.png)\n\n```bash\nmarky README.md --theme retro\n```\n\n![retro](https://user-images.githubusercontent.com/62389790/216391465-ddfff1ad-3cd6-43b8-a193-fc9c664ec018.png)\n\nSee `marky --themes` to show all available themes.\n\nYou can also add your own themes, but it's not documented yet... 😴\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetafates%2Fmarky","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetafates%2Fmarky","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetafates%2Fmarky/lists"}