{"id":15503608,"url":"https://github.com/pomber/docusaurus-mdx-2","last_synced_at":"2025-04-22T23:45:36.371Z","repository":{"id":53880363,"uuid":"479432962","full_name":"pomber/docusaurus-mdx-2","owner":"pomber","description":"A Docusaurus theme to add support for MDX v2","archived":false,"fork":false,"pushed_at":"2022-07-20T13:42:39.000Z","size":609,"stargazers_count":27,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-26T10:44:39.368Z","etag":null,"topics":["docusaurus","docusaurus-theme","mdx"],"latest_commit_sha":null,"homepage":"docusaurus-mdx-2.vercel.app","language":"TypeScript","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/pomber.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":"2022-04-08T14:57:23.000Z","updated_at":"2024-02-25T14:22:51.000Z","dependencies_parsed_at":"2022-08-13T03:11:06.972Z","dependency_job_id":null,"html_url":"https://github.com/pomber/docusaurus-mdx-2","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pomber%2Fdocusaurus-mdx-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pomber%2Fdocusaurus-mdx-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pomber%2Fdocusaurus-mdx-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pomber%2Fdocusaurus-mdx-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pomber","download_url":"https://codeload.github.com/pomber/docusaurus-mdx-2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250343865,"owners_count":21415035,"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":["docusaurus","docusaurus-theme","mdx"],"created_at":"2024-10-02T09:14:13.304Z","updated_at":"2025-04-22T23:45:36.355Z","avatar_url":"https://github.com/pomber.png","language":"TypeScript","readme":"# Docusaurus Theme MDX v2\n\nThis is a Docusaurus theme to add support for MDX v2 [until it is officially supported](https://github.com/facebook/docusaurus/issues/4029).\n\n## Installation\n\n1. Upgrade Docusaurus to version `2.0.0-beta.18` or later\n2. Upgrade your `@mdx-js/react` dependency to version `^2.0.0`\n3. Install `docusaurus-theme-mdx-v2`\n\n```\nnpm install docusaurus-theme-mdx-v2\n```\n\n4. Add `mdx-v2` theme to your `docusaurus.config.js`\n\n```js\n// ...\nconst config = {\n  //...\n  presets: [...],\n  themes: [\"mdx-v2\"],\n  themeConfig: ...\n  //...\n}\n// ...\n```\n\n5. Migrate your .md and .mdx files to MDX v2 if you need. The most common breaking changes are:\n\n- You cannot use comments like this `\u003c!--comment--\u003e` anymore. Now you should use something like `{/* prettier-ignore */}`\n- You need to escape `{` in your prose like this `\\{`\n- If you are using components that aren't imported or part of the `MDXComponents`, MDX v2 will throw an error (v1 only showed a warning)\n\n## Known Issues\n\n### Admonitions syntax doesn't work with MDX v2\n\nInstead of using the markdown syntax for admonitions, you should use the\n`\u003cAdmonition /\u003e` component.\n\nInstead of this:\n\n```md\n:::note Your Title\n\nSome **content** with _markdown_ `syntax`.\n\n:::\n```\n\nUse this:\n\n```md\nimport Admonition from '@theme/Admonition'\n\n\u003cAdmonition type=\"note\" title=\"Your Title\"\u003e\n\nSome **content** with _markdown_ `syntax`.\n\n\u003c/Admonition\u003e\n```\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpomber%2Fdocusaurus-mdx-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpomber%2Fdocusaurus-mdx-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpomber%2Fdocusaurus-mdx-2/lists"}