{"id":18208997,"url":"https://github.com/redsift/i18next-react-markdown","last_synced_at":"2025-04-07T20:25:29.814Z","repository":{"id":57270450,"uuid":"139992064","full_name":"redsift/i18next-react-markdown","owner":"redsift","description":"Embed React elements using markdown in i18next translation strings","archived":false,"fork":false,"pushed_at":"2018-11-07T12:54:28.000Z","size":1348,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-02T03:11:11.276Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://redsift.github.io/i18next-react-markdown/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redsift.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-06T13:59:40.000Z","updated_at":"2022-06-13T01:50:15.000Z","dependencies_parsed_at":"2022-09-08T21:41:30.233Z","dependency_job_id":null,"html_url":"https://github.com/redsift/i18next-react-markdown","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/redsift%2Fi18next-react-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsift%2Fi18next-react-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsift%2Fi18next-react-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsift%2Fi18next-react-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redsift","download_url":"https://codeload.github.com/redsift/i18next-react-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247723412,"owners_count":20985359,"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-11-03T14:03:39.709Z","updated_at":"2025-04-07T20:25:29.797Z","avatar_url":"https://github.com/redsift.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# i18next-react-markdown\n\nEmbed React elements using markdown in i18next translation strings.\n\nThis wraps `marksy` with an HTML element and React component config import util.\n\n## Getting Started\n\n### Install and Build\n\n```sh\nnpm install\n```\n\n### Storybook\n\n#### Run local storybook\n\n```sh\nnpm start\n```\n\n#### Build storybook\n\n```sh\nnpm run storybook:build\n```\n\n\u003e outputs static storybook site to `docs/`\n\n## Usage\n\nThis can be used in your own project and elements can be overriden with custom React components.\n\nLocale keys must have the suffix: `_md` to use markdown.\n\n### Locale usage\n\nExample locale JSON\n\n```json\n{\n  \"website\": \"Website\",\n  \"website-header_md\": \"Visit $t(website)\"\n}\n```\n\n\u003e returns \"`Visit Website`\"\n\n### i18next processor initialisation\n\n```js\nimport mdProcessor, { parser as mdParser } from 'i18next-react-markdown';\n\nconst elements = {\n  h1({ id, children }: Attributes) {\n    return (\n      \u003ch1 id={id}\u003e\n        {children}\n      \u003c/h1\u003e\n    );\n  },\n}\n\nconst components = {\n  Card({ children }: Attributes) {\n    return (\n      \u003cdiv class=\"card\"\u003e\n        {children}\n      \u003c/div\u003e\n    );\n  },\n}\n\nconst mdProcessor = createProcessor({\n  elements,\n  components,\n  marksyOptions: {} // additional marksy input after elements and components\n  markedOptions: {}\n});\n\ni18n\n  .use(mdProcessor)\n  .init({\n    // ...\n    postProcess: ['react-markdown'],\n    // ...\n  })\n```\n\n## Editor usage\n\n```js\nimport Editor from 'i18next-react-markdown/Editor';\n\nreturn (\n  \u003cEditor elements={elements} components={components} /\u003e\n)\n```\n\n## Markdown parser usage\n\n```js\nimport { parser as createMdParser } from 'i18next-react-markdown';\n\n\nconst mdParse = createMdParser(elements, components);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredsift%2Fi18next-react-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredsift%2Fi18next-react-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredsift%2Fi18next-react-markdown/lists"}