{"id":17242738,"url":"https://github.com/imcuttle/remark-preset-gfm","last_synced_at":"2025-04-12T08:21:32.344Z","repository":{"id":33204979,"uuid":"154963797","full_name":"imcuttle/remark-preset-gfm","owner":"imcuttle","description":"Remark preset for gfm","archived":false,"fork":false,"pushed_at":"2022-01-07T14:32:12.000Z","size":87,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T20:39:00.841Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","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/imcuttle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-10-27T12:47:34.000Z","updated_at":"2020-01-26T19:37:15.000Z","dependencies_parsed_at":"2022-08-07T20:15:25.708Z","dependency_job_id":null,"html_url":"https://github.com/imcuttle/remark-preset-gfm","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fremark-preset-gfm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fremark-preset-gfm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fremark-preset-gfm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fremark-preset-gfm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imcuttle","download_url":"https://codeload.github.com/imcuttle/remark-preset-gfm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248537278,"owners_count":21120727,"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":[],"created_at":"2024-10-15T06:13:56.554Z","updated_at":"2025-04-12T08:21:32.313Z","avatar_url":"https://github.com/imcuttle.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remark-preset-gfm\n\n[![Build status](https://img.shields.io/travis/imcuttle/remark-preset-gfm/master.svg?style=flat-square)](https://travis-ci.org/imcuttle/remark-preset-gfm)\n[![Test coverage](https://img.shields.io/codecov/c/github/imcuttle/remark-preset-gfm.svg?style=flat-square)](https://codecov.io/github/imcuttle/remark-preset-gfm?branch=master)\n[![NPM version](https://img.shields.io/npm/v/remark-preset-gfm.svg?style=flat-square)](https://www.npmjs.com/package/remark-preset-gfm)\n[![NPM Downloads](https://img.shields.io/npm/dm/remark-preset-gfm.svg?style=flat-square\u0026maxAge=43200)](https://www.npmjs.com/package/remark-preset-gfm)\n[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)\n\n[Remark](https://github.com/remarkjs/remark) preset for gfm (GitHub Favorite Markdown)\n\n## Features\n\n- Github break line\n- Gemoji\n- Svg head link anchor\n- Code highlight\n\n## Installation\n\n```bash\nnpm install remark-preset-gfm\n# or use yarn\nyarn add remark-preset-gfm\n```\n\n## Usage\n\n```javascript\nconst remark = require('remark')\nconst html = require('remark-html')\nconst gfm = require('remark-preset-gfm')\n\nconst markdownHtml = remark()\n  .use(gfm)\n  .use(html)\n  .processSync('markdown text')\n  .toString()\n\nconst htmlOutput = `\n\u003c!DOCTYPE html\u003e\n\u003chtml lang=\"en\"\u003e\n\u003chead\u003e\n  \u003cmeta charset=\"UTF-8\"\u003e\n  \u003cmeta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"\u003e\n  \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1.0, user-scalable=no\"\u003e\n  \u003clink rel=\"stylesheet\" href=\"//unpkg.com/github-markdown-css\"\u003e\n  \u003clink rel=\"stylesheet\" href=\"//unpkg.com/highlight.js/styles/github.css\"\u003e\n  \u003cstyle\u003e\n    .markdown-body {\n      max-width: 65%;\n      margin: 40px auto 30px;\n    }\n    @media screen and (max-width: 1200px) {\n      .markdown-body {\n        max-width: 78%;\n      }\n    }\n\n    @media screen and (max-width: 700px) {\n      .markdown-body {\n        max-width: 90%;\n        margin: 20px auto 10px;\n      }\n    }\n    @media screen and (max-width: 400px) {\n      .markdown-body {\n        max-width: 98%;\n        margin: 20px auto 10px;\n      }\n    }\n  \u003c/style\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n\u003cdiv class=\"markdown-body\"\u003e\n  ${markdownHtml}\n\u003c/div\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n`\n```\n\n## Related\n\n- [github-markdown-css](https://github.com/sindresorhus/github-markdown-css) - The minimal amount of CSS to replicate the GitHub Markdown style\n- [Highlight.js github style](https://github.com/highlightjs/highlight.js/blob/master/src/styles/github.css)\n\n## Contributing\n\n- Fork it!\n- Create your new branch:  \n  `git checkout -b feature-new` or `git checkout -b fix-which-bug`\n- Start your magic work now\n- Make sure npm test passes\n- Commit your changes:  \n  `git commit -am 'feat: some description (close #123)'` or `git commit -am 'fix: some description (fix #123)'`\n- Push to the branch: `git push`\n- Submit a pull request :)\n\n## Authors\n\nThis library is written and maintained by imcuttle, \u003ca href=\"mailto:moyuyc95@gmail.com\"\u003emoyuyc95@gmail.com\u003c/a\u003e.\n\n## License\n\nMIT - [imcuttle](https://github.com/imcuttle) 🐟\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Fremark-preset-gfm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimcuttle%2Fremark-preset-gfm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Fremark-preset-gfm/lists"}