{"id":17280332,"url":"https://github.com/mavrin/remark-typograf","last_synced_at":"2025-10-15T12:22:38.178Z","repository":{"id":41665870,"uuid":"256741252","full_name":"Mavrin/remark-typograf","owner":"Mavrin","description":"Plugin to make your typography better with https://github.com/typograf","archived":false,"fork":false,"pushed_at":"2024-06-18T01:17:01.000Z","size":1612,"stargazers_count":13,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T23:01:45.143Z","etag":null,"topics":["markdown","remark","remark-plugin","typograf","typographic","typography","unified"],"latest_commit_sha":null,"homepage":"","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/Mavrin.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-18T11:53:58.000Z","updated_at":"2024-12-08T21:46:03.000Z","dependencies_parsed_at":"2024-05-13T10:43:11.558Z","dependency_job_id":"3a2bf3c0-c830-41db-88a0-22e00edca129","html_url":"https://github.com/Mavrin/remark-typograf","commit_stats":{"total_commits":50,"total_committers":2,"mean_commits":25.0,"dds":"0.33999999999999997","last_synced_commit":"4edb876e2b0137bcc6ff434801a6048c42d5d457"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mavrin%2Fremark-typograf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mavrin%2Fremark-typograf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mavrin%2Fremark-typograf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mavrin%2Fremark-typograf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mavrin","download_url":"https://codeload.github.com/Mavrin/remark-typograf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248855819,"owners_count":21172649,"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":["markdown","remark","remark-plugin","typograf","typographic","typography","unified"],"created_at":"2024-10-15T09:20:03.348Z","updated_at":"2025-10-15T12:22:33.135Z","avatar_url":"https://github.com/Mavrin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remarkjs-typograf\n\nPlugin for [remark](https://github.com/remarkjs/remark) to make your typography better with [typograf](https://github.com/typograf/typograf)\n\nExample https://mavrin.github.io/remark-typograf/\n\n## Install\n\n[npm](https://docs.npmjs.com/cli/install):\n\n```sh\nnpm install @mavrin/remark-typograf remark\n```\n\n## Use\n\nSay we have the following file, `example.md`:\n\n````markdown\n## spread operator `...`\n\nIt is test...\n\n```js\nfunction test(...args) {\n  return args;\n}\n```\n````\n\nYou probably want to use it on the CLI through a config file:\n\n```diff\n  …\n  \"remarkConfig\": {\n    \"plugins\": [\n      [\n        \"@mavrin/remark-typograf\",\n        {\n          \"locale\": [\"ru\"]\n        }\n      ]\n    ]\n  }\n…\n```\n\nOr use it on the CLI directly (ru locale will be used as default)\n\n```sh\nremark -u @mavrin/remark-typograf example.md -o processed-example.md\n```\n\nOr use this on the API:\n\n```js\nconst fs = require(\"fs\");\nconst path = require(\"path\");\nconst remark = require(\"remark\");\nconst remarkTypograf = require(\"@mavrin/remark-typograf\");\n\nconst processed = remark()\n  .use(remarkTypograf, { locale: [\"en-US\"], keywords: [\":)\"] })\n  .processSync(fs.readFileSync(path.resolve(__dirname, \"example.md\")));\n\nfs.writeFileSync(path.resolve(__dirname, \"processed-example.md\"), processed);\n```\n\nor with custom typograf:\n\n```js\nconst fs = require(\"fs\");\nconst path = require(\"path\");\nconst remark = require(\"remark\");\nconst remarkTypograf = require(\"@mavrin/remark-typograf\");\nconst Typograf = require(\"typograf\");\n\nconst processed = remark()\n  .use(remarkTypograf, {\n    typograf: new Typograf({ locale: [\"en-US\"] }),\n    keywords: [\":)\"],\n    builtIn: false,\n  })\n  .processSync(fs.readFileSync(path.resolve(__dirname, \"example.md\")));\n\nfs.writeFileSync(path.resolve(__dirname, \"processed-example.md\"), processed);\n```\n\nYields:\n\n````markdown\n## spread operator `...`\n\nIt is test…\n\n```js\nfunction test(...args) {\n  return args;\n}\n```\n````\n\n[Example source code](/examples/simple)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmavrin%2Fremark-typograf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmavrin%2Fremark-typograf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmavrin%2Fremark-typograf/lists"}