{"id":21908655,"url":"https://github.com/kpym/gm","last_synced_at":"2025-04-16T01:53:50.320Z","repository":{"id":57555770,"uuid":"312655001","full_name":"kpym/gm","owner":"kpym","description":"Cli tool converting Markdown to HTML. This tool is a thin wrapper around the github.com/yuin/goldmark library.","archived":false,"fork":false,"pushed_at":"2025-01-17T17:56:50.000Z","size":93,"stargazers_count":16,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T03:51:12.115Z","etag":null,"topics":["cli","go","golang","http-server","markdown","static-site-generator"],"latest_commit_sha":null,"homepage":"","language":"Go","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/kpym.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}},"created_at":"2020-11-13T18:33:48.000Z","updated_at":"2025-03-26T11:11:03.000Z","dependencies_parsed_at":"2024-02-17T11:24:17.724Z","dependency_job_id":"5b15421d-d336-4317-b184-b3dda5d26ea3","html_url":"https://github.com/kpym/gm","commit_stats":null,"previous_names":["kpym/goldmark-cli"],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpym%2Fgm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpym%2Fgm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpym%2Fgm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpym%2Fgm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kpym","download_url":"https://codeload.github.com/kpym/gm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249183091,"owners_count":21226140,"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","go","golang","http-server","markdown","static-site-generator"],"created_at":"2024-11-28T17:13:11.768Z","updated_at":"2025-04-16T01:53:50.301Z","avatar_url":"https://github.com/kpym.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gm (a goldmark cli tool)\n\nA cli tool converting Markdown to HTML.\nThis tool is a thin wrapper around the [github.com/yuin/goldmark](https://github.com/yuin/goldmark) library.\n\n\n## Usage\n\n### Single md to html\n\n```\n\u003e gm file.md\n```\n\n### Open (and watch) md file in the browser\n\n```\n\u003e gm --serve file.md\n```\n\n\n### The usage message\n\n```\n\u003e gm -h\ngm (version: 0.19.1): a goldmark cli tool which is a thin wrapper around github.com/yuin/goldmark (versio: v1.7.8).\n\n  If not serving (no '--serve' or '-s' option is used):\n  - the .md files are converted and saved as .html with the same base name;\n  - if the corresponding .html file already exists, it is overwritten;\n  - 'stdin' is converted to 'stdout';\n  - when a pattern is used, only the matched .md files are considered.\n  - the pattern can contain '*', '?', the '**' glob pattern, '[class]' and {alt1,...} alternatives.\n\n  When serving (with '--serve' or '-s' option):\n  - the .md files are converted and served as html with live.js (for live updates);\n  - all other files are staticly served;\n  - nothing is written on the disk.\n\n  -s, --serve                    Start serving local .md file(s). No html is saved.\n      --timeout int              Timeout in seconds for stop serving if no (non static) request. Default is 0 (no timeout).\n  -c, --css stringArray          A css content or url or the theme name present in github.com/kpym/markdown-css. Multiple values are allowed. (default [github])\n  -t, --title string             The page title. If empty, search for \u003ch1\u003e in the resulting html.\n      --html string              The html template (file or string).\n  -o, --out-dir string           The build output folder (created if not already existing, not used when serving).\n      --readme-index             Compile README.md to index.html (not used when serving).\n      --move-no-md               Move all non markdown non dot files to the output folder (not used when serving).\n      --skip-dot                 Skip dot files (not used when serving).\n      --pages                    Shortcut for --outdir='public' --readme-index --move-no-md --skip-dot (not used when serving).\n      --links-md2html            Replace .md with .html in links to local files (not used when serving). (default true)\n      --gm-attribute             goldmark option: allows to define attributes on some elements. (default true)\n      --gm-auto-heading-id       goldmark option: enables auto heading ids. (default true)\n      --gm-definition-list       goldmark option: enables definition lists. (default true)\n      --gm-footnote              goldmark option: enables footnotes. (default true)\n      --gm-linkify               goldmark option: activates auto links. (default true)\n      --gm-strikethrough         goldmark option: enables strike through. (default true)\n      --gm-table                 goldmark option: enables tables. (default true)\n      --gm-task-list             goldmark option: enables task lists. (default true)\n      --gm-typographer           goldmark option: activate punctuations substitution with typographic entities. (default true)\n      --gm-emoji                 goldmark option: enables (github) emojis 💪. (default true)\n      --gm-unsafe                goldmark option: enables raw html. (default true)\n      --gm-hard-wraps            goldmark option: render newlines as \u003cbr\u003e.\n      --gm-xhtml                 goldmark option: render as XHTML.\n      --gm-highlighting string   goldmark option: the code highlighting theme (empty string to disable).\n                                 Check github.com/alecthomas/chroma for theme names. (default \"github\")\n      --gm-line-numbers          goldmark option: enable line numering for code highlighting.\n  -q, --quiet                    No errors and no info is printed. Return error code is still available.\n  -h, --help                     Print this help message.\n```\n\n### How to\n\nFor more usage information check the [HOWTO](HOWTO.md) documentation.\n\n## Installation\n\n### Precompiled executables\n\nYou can download the executable for your platform from the [Releases](https://github.com/kpym/gm/releases).\n\n### Compile it yourself\n\n#### Using Go\n\n```\n$ go install github.com/kpym/gm@latest\n```\n\n#### Using goreleaser\n\nAfter cloning this repo you can compile the sources with [goreleaser](https://github.com/goreleaser/goreleaser/) for all available platforms:\n\n```\ngit clone https://github.com/kpym/gm.git .\ngoreleaser --snapshot --skip-publish --clean\n```\n\nYou will find the resulting binaries in the `dist/` sub-folder.\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkpym%2Fgm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkpym%2Fgm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkpym%2Fgm/lists"}