Skip to content

Commit f3d0d77

Browse files
docs: include architecture overview
1 parent 7488423 commit f3d0d77

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

readme.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,22 @@ export default ExampleComponent;
114114
A set of runnable examples are provided through storybook at <https://christianmurphy.github.io/react-remark>.
115115
The source for the story files can be found in [_/stories_](./stories).
116116

117+
## Architecture
118+
119+
```
120+
react-remark
121+
+---------------------------------------------------------------------------------------------------------------------------------------------+
122+
| |
123+
| +----------+ +----------------+ +---------------+ +----------------+ +--------------+ |
124+
| | | | | | | | | | | |
125+
| -markdown->+ remark +-mdast+>+ remark plugins +-mdast->+ remark-rehype +-hast->+ rehype plugins +-hast->+ rehype-react +-react elements-> |
126+
| | | | | | | | | | | |
127+
| +----------+ +----------------+ +---------------+ +----------------+ +--------------+ |
128+
| |
129+
+---------------------------------------------------------------------------------------------------------------------------------------------+
130+
131+
```
132+
117133
## Options
118134

119135
- `remarkParseOptions` (Object) - configure how Markdown is parsed, same as [`remark-parse` options](https://github.com/remarkjs/remark/tree/master/packages/remark-parse#options)

0 commit comments

Comments
 (0)