Skip to content

Commit

Permalink
fix 207 (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfix-stripe committed Sep 21, 2022
1 parent 593a654 commit 2314d78
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 16 deletions.
9 changes: 8 additions & 1 deletion README.md
Expand Up @@ -53,7 +53,14 @@ 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` in order to use Markdoc in your TypeScript project

When using TypeScript, install Markdoc with:

```sh
npm install @markdoc/markdoc @types/react @types/markdown-it
```

Additionally, this is the minimal `tsconfig.json` required to use Markdoc in your TypeScript project:

```json
{
Expand Down
42 changes: 28 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -32,7 +32,7 @@
"engines": {
"node": ">=14.7.0"
},
"dependencies": {
"peerDependencies": {
"@types/markdown-it": "*",
"@types/react": "*"
},
Expand Down

0 comments on commit 2314d78

Please sign in to comment.