{"id":18926775,"url":"https://github.com/ladjs/remark-preset-github","last_synced_at":"2025-04-15T13:33:20.580Z","repository":{"id":42367807,"uuid":"100912843","full_name":"ladjs/remark-preset-github","owner":"ladjs","description":"GitHub markdown and prose style","archived":false,"fork":false,"pushed_at":"2022-06-06T05:22:53.000Z","size":875,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T02:01:54.356Z","etag":null,"topics":["automatic","formatting","github","markdown","node","npm","preset","prose","remark","syntax"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ladjs.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}},"created_at":"2017-08-21T04:36:55.000Z","updated_at":"2022-06-01T04:24:07.000Z","dependencies_parsed_at":"2022-08-29T19:10:21.163Z","dependency_job_id":null,"html_url":"https://github.com/ladjs/remark-preset-github","commit_stats":null,"previous_names":["niftylettuce/remark-preset-github"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladjs%2Fremark-preset-github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladjs%2Fremark-preset-github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladjs%2Fremark-preset-github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladjs%2Fremark-preset-github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladjs","download_url":"https://codeload.github.com/ladjs/remark-preset-github/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249080482,"owners_count":21209535,"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":["automatic","formatting","github","markdown","node","npm","preset","prose","remark","syntax"],"created_at":"2024-11-08T11:17:08.810Z","updated_at":"2025-04-15T13:33:20.306Z","avatar_url":"https://github.com/ladjs.png","language":"JavaScript","readme":"# remark-preset-github\n\nGitHub markdown and prose style.\n\n[Learn more about presets in unified's docs][docs].\n\n\u003e **NOTE**: Feel free to open an issue if something isn't working right.\n\n\n## Installation\n\n[npm][npm-install]:\n\n```sh\nnpm install remark-cli remark-preset-github --save\n```\n\nNow add the following to your `package.json`:\n\n```js\n  \"scripts\": {\n    \"build-md\": \"remark .\"\n    \"test\": \"npm run build-md \u0026\u0026 ...\"\n  },\n  \"remarkConfig\": {\n    \"plugins\": [\n      \"preset-github\"\n    ]\n  },\n```\n\nFrom now on, `npm test` also checks markdown.\n\n```sh\nnpm test\n```\n\n\n## Checks\n\n###### Markdown\n\n* Adds a [license section][remark-license]\n* Adds a [contributors section][remark-contributors]\n* Extends [`remark-preset-lint-recommended`][lint-recommended],\n  and adds a strict code-style (see [`index.js`][index])\n* Markdown is compiled with asterisk list-item bullets (`*`),\n  and fenced code blocks (note: set `output: true` in your config to\n  benefit from this)\n* How remark compiles can be configured inline with [comments][comments]\n* `Table of Contents` headers are kept up to date, with a depth of `3`\n  (if `output: true`)\n* [GH references][github], like mentions or issue references, are\n  linked (if `output: true`)\n\n###### Natural Language\n\nSee [`retext-preset-github`][retext-preset] for more info.\n\n* [English][english] parsing\n* Two [spaces][spaces] between sentences\n* Checks [\"indefinite articles\"][articles]: \"a\" or \"an\"\n* Checks [quotes and apostrophes][quotes] (`“”` \u003e `\"\"`)\n* Checks accidental [repeated words][repeated]\n* Checks [diacritics][diacritics]\n* Checks [redundant acronyms][ras]\n* Checks incorrectly placed apostrophes in [contractions][contractions]\n\n\n## Contributors\n\n| Name           | website                    |\n| -------------- | -------------------------- |\n| **Nick Baugh** | \u003chttps://niftylettuce.com\u003e |\n\n\n## License\n\n[MIT](LICENSE) © Titus Wormer\n\n\n##\n\n[npm-install]: https://docs.npmjs.com/cli/install\n\n[index]: ./index.js\n\n[lint-recommended]: https://github.com/wooorm/remark-lint/tree/master/packages/remark-preset-lint-recommended\n\n[github]: https://github.com/wooorm/remark-github\n\n[comments]: https://github.com/wooorm/remark-comment-config\n\n[retext-preset]: https://github.com/niftylettuce/retext-preset-github\n\n[english]: https://github.com/wooorm/retext/tree/master/packages/retext-english\n\n[spaces]: https://github.com/wooorm/retext-sentence-spacing\n\n[articles]: https://github.com/wooorm/retext-indefinite-article\n\n[quotes]: https://github.com/wooorm/retext-quotes\n\n[repeated]: https://github.com/wooorm/retext-repeated-words\n\n[contractions]: https://github.com/wooorm/retext-contractions\n\n[diacritics]: https://github.com/wooorm/retext-diacritics\n\n[ras]: https://github.com/wooorm/retext-redundant-acronyms\n\n[docs]: https://github.com/unifiedjs/unified#preset\n\n[remark-license]: https://github.com/wooorm/remark-license\n\n[remark-contributors]: https://github.com/hughsk/remark-contributors\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladjs%2Fremark-preset-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladjs%2Fremark-preset-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladjs%2Fremark-preset-github/lists"}