{"id":25096563,"url":"https://github.com/jceb/remark-format-cli","last_synced_at":"2026-04-12T15:40:55.208Z","repository":{"id":64419627,"uuid":"575477463","full_name":"jceb/remark-format-cli","owner":"jceb","description":"remark-based CLI formatter for Markdown files","archived":false,"fork":false,"pushed_at":"2024-07-30T16:58:55.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-30T00:16:54.625Z","etag":null,"topics":["cli","deno","github","javascript","markdown","markdown-toc","readme","shell","table-of-contents","toc"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jceb.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":"2022-12-07T15:48:30.000Z","updated_at":"2024-07-30T16:58:57.000Z","dependencies_parsed_at":"2024-03-02T15:40:25.785Z","dependency_job_id":"8fbb9768-dfab-4a6a-b206-9d599956eaa4","html_url":"https://github.com/jceb/remark-format-cli","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/jceb/remark-format-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fremark-format-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fremark-format-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fremark-format-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fremark-format-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jceb","download_url":"https://codeload.github.com/jceb/remark-format-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fremark-format-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259619453,"owners_count":22885521,"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","deno","github","javascript","markdown","markdown-toc","readme","shell","table-of-contents","toc"],"created_at":"2025-02-07T16:48:53.686Z","updated_at":"2026-04-12T15:40:50.164Z","avatar_url":"https://github.com/jceb.png","language":"TypeScript","readme":"# remark-format-cli\n\nremark-based CLI formatter for Markdown files, that generates table of contents.\n\n- Source code:\n  [github.com/jceb/remark-format-cli](https://github.com/jceb/remark-format-cli)\n- Deno module:\n  [deno.land/x/remark_format_cli](https://deno.land/x/remark_format_cli)\n\n\u003c!-- generated with\n!deno run --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.4.0/remark-format.js --maxdepth 2 %\n--\u003e\n\n## Table of Contents\n\n1. [Usage](#usage)\n2. [Install](#install)\n3. [Configuration](#configuration)\n4. [History](#history)\n\n## Usage\n\nIf you want to generate a table of contents in your markdown file, Add a heading\ncalled `Contents` before running the script. The table of contents will be added\nbeneath the heading.\n\nFormat a Markdown file:\n\n```bash\ndeno run --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.4.0/remark-format.js README.md\n```\n\nOr with the locally [installed](#install) script:\n\n```bash\nremark-format README.md\n```\n\n## Install\n\n```bash\ndeno install --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.4.0/remark-format.js\n```\n\nOnce installed, the local command `remark-format` will be available.\n\n## Configuration\n\nCurrently, there are no configuration or command line options. Hopefully,\nconfiguration options will be added in the future. For the moment, it's very\neasy to customize the code directly in\n[`./remark-format.js`](./remark-format.js)\n\n## History\n\nThere are many markdown table of contents generators. However, I haven't found\none yet that generates an ordered list and is well maintained. Furthermore, I'd\nvery much prefer a simple, if possible non-existent, installation process.\n\nWith this in mind, I found\n[`remark-toc`](https://github.com/remarkjs/remark-toc) and opted for\n[`deno`](https://deno.land/) as a runtime since it recently added support for\nNPM modules. This combination made it very simple to create a custom remark CLI\nthat integrates the [`remark-toc`](https://github.com/remarkjs/remark-toc)\nplugin.\n\nTOC generators I've tried before:\n\n- [ycd/toc](https://github.com/ycd/toc) - works well but the installation is a\n  bit of a struggle\n- [gh-md-toc](https://github.com/ekalinin/github-markdown-toc) - doesn't support\n  ordered tocs\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjceb%2Fremark-format-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjceb%2Fremark-format-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjceb%2Fremark-format-cli/lists"}