{"id":13454644,"url":"https://github.com/markdoc/markdoc","last_synced_at":"2025-05-13T15:06:05.494Z","repository":{"id":36982046,"uuid":"490388312","full_name":"markdoc/markdoc","owner":"markdoc","description":"A powerful, flexible, Markdown-based authoring framework.","archived":false,"fork":false,"pushed_at":"2025-05-02T17:21:18.000Z","size":274,"stargazers_count":7509,"open_issues_count":22,"forks_count":186,"subscribers_count":29,"default_branch":"main","last_synced_at":"2025-05-05T22:41:59.546Z","etag":null,"topics":["authoring","documentation","markdoc","markdown","react","toolchain"],"latest_commit_sha":null,"homepage":"https://markdoc.dev","language":"TypeScript","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/markdoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2022-05-09T17:50:46.000Z","updated_at":"2025-05-04T13:17:47.000Z","dependencies_parsed_at":"2023-02-17T09:46:26.891Z","dependency_job_id":"dde41746-e9e6-48bf-ae9e-1ed2a1cc2d00","html_url":"https://github.com/markdoc/markdoc","commit_stats":{"total_commits":102,"total_committers":12,"mean_commits":8.5,"dds":"0.28431372549019607","last_synced_commit":"ce14a807a06b97d4b4d0575daa356addb06a1cd0"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdoc%2Fmarkdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdoc%2Fmarkdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdoc%2Fmarkdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdoc%2Fmarkdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markdoc","download_url":"https://codeload.github.com/markdoc/markdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166661,"owners_count":21864508,"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":["authoring","documentation","markdoc","markdown","react","toolchain"],"created_at":"2024-07-31T08:00:56.310Z","updated_at":"2025-05-13T15:06:05.446Z","avatar_url":"https://github.com/markdoc.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003e\n  \u003cbr\u003e\n    \u003cimg src=\"https://user-images.githubusercontent.com/62121649/167893184-a2b69260-ca9e-4a77-a5bc-63b8135ae5db.png\" alt=\"Markdoc\" width=\"260\"\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eA powerful, flexible, Markdown-based authoring framework.\u003c/h4\u003e\n\nMarkdoc is a [Markdown](https://commonmark.org)-based syntax and toolchain for creating custom documentation sites and experiences.  \nWe designed Markdoc to power [Stripe's public docs](http://stripe.com/docs), our largest and most complex content site.\n\n## Installation\n\nTo get started with Markdoc, first install the library:\n\n```shell\nnpm install @markdoc/markdoc\n```\n\nor\n\n```shell\nyarn add @markdoc/markdoc\n```\n\nand import it in your app:\n\n```js\nconst Markdoc = require('@markdoc/markdoc');\n```\n\nor if you are using ESM\n\n```js\nimport Markdoc from '@markdoc/markdoc';\n```\n\nthen use `Markdoc` in your app or tool:\n\n```js\nconst doc = `\n# Markdoc README\n\n{% image src=\"/logo.svg\" /%}\n`;\n\nconst ast = Markdoc.parse(doc);\nconst content = Markdoc.transform(ast);\nreturn Markdoc.renderers.react(content, React);\n```\n\nCheck out [our docs](https://markdoc.dev/docs) for more guidance on how to use Markdoc.\n\n### TypeScript\n\nThis is the minimal `tsconfig.json` required to use Markdoc in your TypeScript project:\n\n```json\n{\n  \"compilerOptions\": {\n    \"moduleResolution\": \"node\",\n    \"target\": \"esnext\", // works with es2015 or greater\n    \"esModuleInterop\": true\n  }\n}\n```\n\n### React\n\nIf you are using React, install Markdoc with:\n\n```sh\nnpm install @markdoc/markdoc react @types/react\n```\n\n## Contributing\n\nContributions and feedback are welcome and encouraged. Check out our [contributing guidelines](.github/CONTRIBUTING.md) on how to do so.\n\n### Development\n\n1. Run `npm install`\n1. Run `npm run build`\n1. Run the tests using `npm test`\n\n## Code of conduct\n\nThis project has adopted the Stripe [Code of conduct](.github/CODE_OF_CONDUCT.md).\n\n## License\n\nThis project uses the [MIT license](LICENSE).\n\n## Credits\n\nSpecial shout out to:\n\n- [@marcioAlmada](https://github.com/marcioAlmada) for providing us with the [@markdoc](https://github.com/markdoc) GitHub org.\n- [@koomen](https://github.com/koomen) for gifting us https://markdoc.dev.\n","funding_links":[],"categories":["TypeScript","Development","react","General Tools","\u003ca name=\"TypeScript\"\u003e\u003c/a\u003eTypeScript"],"sub_categories":["VoIP","Site Builder"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdoc%2Fmarkdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkdoc%2Fmarkdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdoc%2Fmarkdoc/lists"}