From 2b5f334e42e9b5c40fe85b639eb1514728098a78 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 21 Jan 2026 18:20:34 +0000 Subject: [PATCH 1/2] Initial plan From 4998f6229e06abf939ace8b0d101d37d29e067ca Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 21 Jan 2026 18:23:09 +0000 Subject: [PATCH 2/2] docs: update README to note fork and upstream link Co-authored-by: gipsy777 <247768348+gipsy777@users.noreply.github.com> --- README.md | 102 ++++-------------------------------------------------- 1 file changed, 6 insertions(+), 96 deletions(-) diff --git a/README.md b/README.md index 3734111..2c7e763 100644 --- a/README.md +++ b/README.md @@ -1,100 +1,10 @@ -

-
- Markdoc -
-
-

+# markdoc (fork) -

A powerful, flexible, Markdown-based authoring framework.

+This repository is a fork of the original Markdoc project: https://github.com/markdoc/markdoc -Markdoc is a [Markdown](https://commonmark.org)-based syntax and toolchain for creating custom documentation sites and experiences. -We designed Markdoc to power [Stripe's public docs](http://stripe.com/docs), our largest and most complex content site. +Markdoc is a powerful, flexible, Markdown-based authoring framework originally developed by Stripe. This fork currently contains no additional code changes and preserves the original project's MIT license. -## Installation +If you plan to contribute or customize this project, please sync with the upstream repository, open issues, and create pull requests describing your changes. -To get started with Markdoc, first install the library: - -```shell -npm install @markdoc/markdoc -``` - -or - -```shell -yarn add @markdoc/markdoc -``` - -and import it in your app: - -```js -const Markdoc = require('@markdoc/markdoc'); -``` - -or if you are using ESM - -```js -import Markdoc from '@markdoc/markdoc'; -``` - -then use `Markdoc` in your app or tool: - -```js -const doc = ` -# Markdoc README - -{% image src="/logo.svg" /%} -`; - -const ast = Markdoc.parse(doc); -const content = Markdoc.transform(ast); -return Markdoc.renderers.react(content, React); -``` - -Check out [our docs](https://markdoc.dev/docs) for more guidance on how to use Markdoc. - -### TypeScript - -This is the minimal `tsconfig.json` required to use Markdoc in your TypeScript project: - -```json -{ - "compilerOptions": { - "moduleResolution": "node", - "target": "esnext", // works with es2015 or greater - "esModuleInterop": true - } -} -``` - -### React - -If you are using React, install Markdoc with: - -```sh -npm install @markdoc/markdoc react @types/react -``` - -## Contributing - -Contributions and feedback are welcome and encouraged. Check out our [contributing guidelines](.github/CONTRIBUTING.md) on how to do so. - -### Development - -1. Run `npm install` -1. Run `npm run build` -1. Run the tests using `npm test` - -## Code of conduct - -This project has adopted the Stripe [Code of conduct](.github/CODE_OF_CONDUCT.md). - -## License - -This project uses the [MIT license](LICENSE). - -## Credits - -Special shout out to: - -- [@marcioAlmada](https://github.com/marcioAlmada) for providing us with the [@markdoc](https://github.com/markdoc) GitHub org. -- [@koomen](https://github.com/koomen) for gifting us https://markdoc.dev. +Original project: https://github.com/markdoc/markdoc +License: MIT