{"id":48866756,"url":"https://github.com/qz-project/remark-gfm-custom","last_synced_at":"2026-04-15T19:00:59.143Z","repository":{"id":337977967,"uuid":"1156083718","full_name":"qz-project/remark-gfm-custom","owner":"qz-project","description":"A configurable remark-gfm that allows you to toggle the GitHub Flavored Markdown (GFM) features.","archived":false,"fork":false,"pushed_at":"2026-04-02T05:09:26.000Z","size":111,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-13T17:50:41.881Z","etag":null,"topics":["autolink","footnote","gfm","github","markdown","mdast","plugin","remark","remark-plugin","strikethrough","table","tasklist","unified"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/remark-gfm-custom","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/qz-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"quadratz"}},"created_at":"2026-02-12T08:40:52.000Z","updated_at":"2026-02-13T04:35:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/qz-project/remark-gfm-custom","commit_stats":null,"previous_names":["quadratz/remark-gfm-custom","quadratz-org/remark-gfm-custom","qz-project/remark-gfm-custom"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/qz-project/remark-gfm-custom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qz-project%2Fremark-gfm-custom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qz-project%2Fremark-gfm-custom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qz-project%2Fremark-gfm-custom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qz-project%2Fremark-gfm-custom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qz-project","download_url":"https://codeload.github.com/qz-project/remark-gfm-custom/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qz-project%2Fremark-gfm-custom/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31855432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"ssl_error","status_checked_at":"2026-04-15T15:24:39.138Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["autolink","footnote","gfm","github","markdown","mdast","plugin","remark","remark-plugin","strikethrough","table","tasklist","unified"],"created_at":"2026-04-15T19:00:57.534Z","updated_at":"2026-04-15T19:00:59.133Z","avatar_url":"https://github.com/qz-project.png","language":"TypeScript","funding_links":["https://github.com/sponsors/quadratz"],"categories":[],"sub_categories":[],"readme":"# remark-gfm-custom\n\n[![npm Version][npm-badge]][npm] [![JSR Version][jsr-badge]][jsr]\n[![GitHub Release][github-badge]][github-release]\n\nA configurable [remark-gfm][remark-gfm] that allows you to toggle the [GitHub Flavored Markdown\n(GFM)][gfm] features.\n\nThis package has the same functionality as [remark-gfm], with the additional ability to enable or\ndisable specific GFM features like autolinks, footnotes, tables, and more.\n\n## Installation\n\n`remark-gfm-custom` is available on both [npm.com][npm] and [JSR.io][jsr].\n\n### Using npm\n\n```bash\n# Deno\ndeno add npm:remark-gfm-custom\n\n# Bun\nbun add remark-gfm-custom\n\n# pnpm\npnpm add remark-gfm-custom\n\n# npm\nnpm install remark-gfm-custom\n```\n\n### Using JSR\n\n```bash\n# Deno - JSR\ndeno add jsr:@qz/remark-gfm-custom\n\n# Bun - JSR\nbunx jsr add @qz/remark-gfm-custom\n\n# pnpm - JSR\npnpm i jsr:@qz/remark-gfm-custom\n\n# npm - JSR\nnpx jsr add @qz/remark-gfm-custom\n```\n\n## Usage\n\n```ts\nimport assert from \"node:assert\";\nimport remarkParse from \"remark-parse\";\nimport remarkRehype from \"remark-rehype\";\nimport rehypeStringify from \"rehype-stringify\";\nimport { unified } from \"unified\";\nimport { remarkGfmCustom } from \"remark-gfm-custom\";\n\nconst file = await unified()\n  .use(remarkParse)\n  // This disables the GFM autolink feature.\n  .use(remarkGfmCustom, { plugins: { autolinkLiteral: false } })\n  .use(remarkRehype)\n  .use(rehypeStringify)\n  .process(\"https://example.com\");\n\nassert.equal(file.toString(), \"\u003cp\u003ehttps://example.com\u003c/p\u003e\");\n```\n\n### API\n\nThis package exports the following:\n\n#### `remarkGfmCustom`\n\n```ts\nfunction remarkGfmCustom(options?: Options): void;\n```\n\nThe main plugin. It receives one optional parameter to configure behavior. See the\n[`Options` section](#options) below for configuration details.\n\n#### `Options`\n\n```ts\ntype Options = {\n  remarkGfm?: FootnoteOptions | TableOptions | StrikethroughOptions;\n  plugins?: {\n    autolinkLiteral?: boolean;\n    footnote?: boolean;\n    strikethrough?: boolean;\n    table?: boolean;\n    taskListItem?: boolean;\n  };\n};\n```\n\nConfiguration for [`remarkGfmCustom`](#remarkgfmcustom). This consists of two main categories:\n[`remarkGfm`](#remarkgfm) and [`plugins`](#plugins).\n\n##### `remarkGfm`\n\n```ts\ntype remarkGfm = FootnoteOptions | TableOptions | StrikethroughOptions;\n```\n\nOptions passed directly to the [remark-gfm][remark-gfm] plugins. The available fields are:\n\n##### `firstLineBlank`\n\n```ts\ntype firstLineBlank = boolean;\n```\n\nSerialize with a blank line for the first line of footnote definitions.\n\n- Default: `false`.\n- Reference: \u003chttps://github.com/remarkjs/remark-gfm#options\u003e\n\n##### `stringLength`\n\n```ts\ntype stringLength = (value: string) =\u003e number;\n```\n\nDetect the size of table cells, used when aligning cells.\n\n- Default: `d =\u003e d.length`.\n- Reference: \u003chttps://github.com/remarkjs/remark-gfm#options\u003e\n\n##### `singleTilde`\n\n```ts\ntype singleTilde = boolean;\n```\n\nWhether to support strikethrough with a single tilde. Single tildes work on GitHub but are\ntechnically prohibited by GFM.\n\n- Default: `true`.\n- Reference: \u003chttps://github.com/remarkjs/remark-gfm#options\u003e\n\n##### `tablePipeAlign`\n\n```ts\ntype tablePipeAlign = boolean;\n```\n\nWhether to align table pipes.\n\n- Default: `true`.\n- Reference: \u003chttps://github.com/remarkjs/remark-gfm#options\u003e\n\n##### `tableCellPadding`\n\n```ts\ntype tableCellPadding = boolean;\n```\n\nWhether to add a space of padding between table pipes and cells.\n\n- Default: `true`.\n- Reference: \u003chttps://github.com/remarkjs/remark-gfm#options\u003e\n\n##### `plugins`\n\nOptions to enable or disable specific [remark-gfm][remark-gfm] bundled plugins.\n\nAll fields below are `boolean` and default to `true`. Set a field to `false` to disable that\nspecific GFM feature.\n\n##### `autolinkLiteral`\n\nToggle\n[GFM literal autolinks](https://github.com/micromark/micromark-extension-gfm-autolink-literal).\n\n##### `footnote`\n\nToggle the [GFM footnotes](https://github.com/micromark/micromark-extension-gfm-footnote).\n\n##### `strikethrough`\n\nToggle the [GFM strikethrough](https://github.com/micromark/micromark-extension-gfm-strikethrough).\n\n##### `table`\n\nToggle the [GFM tables](https://github.com/micromark/micromark-extension-gfm-table).\n\n##### `taskListItem`\n\nToggle the\n[GFM task list items](https://github.com/micromark/micromark-extension-gfm-task-list-item).\n\n## Contributing\n\nPlease see [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.\n\n## License\n\n[MIT](./LICENSE)\n\n[gfm]: https://github.github.com/gfm/\n[github-badge]:\n  https://img.shields.io/github/v/release/qz-project/remark-gfm-custom?style=for-the-badge\u0026logo=github\u0026logoSize=auto\u0026label=%20\u0026labelColor=%23181717\u0026color=%23edede6\n[github-release]: https://github.com/qz-project/remark-gfm-custom/releases\n[jsr]: https://jsr.io/@qz/remark-gfm-custom\n[jsr-badge]:\n  https://img.shields.io/jsr/v/%40qz/remark-gfm-custom?style=for-the-badge\u0026logo=jsr\u0026logoColor=%23163c4c\u0026logoSize=auto\u0026label=%20\u0026labelColor=%23ead527\u0026color=%23FAF6D1\n[npm]: https://npmjs.com/package/remark-gfm-custom\n[npm-badge]:\n  https://img.shields.io/npm/v/remark-gfm-custom?style=for-the-badge\u0026logo=npm\u0026logoSize=auto\u0026label=%20\u0026labelColor=%23ce0000\u0026color=%23FFE9E9\n[remark-gfm]: https://github.com/remarkjs/remark-gfm\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqz-project%2Fremark-gfm-custom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqz-project%2Fremark-gfm-custom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqz-project%2Fremark-gfm-custom/lists"}