diff options
| -rw-r--r-- | readme.md | 181 |
1 files changed, 90 insertions, 91 deletions
@@ -64,6 +64,62 @@ cargo doc --document-private-items - [ ] (5) Figure out extensions - [ ] (1) Support turning off constructs +### Constructs + +- [ ] (5) attention (strong, emphasis) +- [x] autolink +- [x] blank line +- [ ] (5) block quote +- [x] character escape +- [x] character reference +- [x] code (fenced) +- [x] code (indented) +- [x] code (text) +- [x] definition +- [x] hard break (escape) +- [x] hard break (trailing) +- [x] heading (atx) +- [x] heading (setext) +- [x] html (flow) +- [x] html (text) +- [ ] (3) label end +- [ ] (3) label start (image) +- [ ] (3) label start (link) +- [ ] (8) list +- [x] paragraph +- [x] thematic break + +### Content types + +- [ ] (8) container + - [ ] block quote + - [ ] list +- [x] flow + - [x] blank line + - [x] code (fenced) + - [x] code (indented) + - [x] definition + - [x] heading (atx) + - [x] heading (setext) + - [x] html (flow) + - [x] paragraph + - [x] thematic break +- [ ] (8) text + - [ ] attention (strong, emphasis) (text) + - [x] autolink + - [x] character escape + - [x] character reference + - [x] code (text) + - [x] hard break (escape) + - [x] hard break (trailing) + - [x] html (text) + - [ ] label end + - [ ] label start (image) + - [ ] label start (link) +- [x] string + - [x] character escape + - [x] character reference + ### All the things #### Docs @@ -127,67 +183,44 @@ cargo doc --document-private-items - [ ] (3) Bunch of docs - [ ] (5) Site -#### After - -- [ ] (8) Extensions! -- [ ] (8) After all extensions, including MDX, are done, see if we can integrate - this with SWC to compile MDX +### Extensions -### Constructs +The main thing here is is to figure out if folks could extend from the outside +with their own code, or if we need to maintain it all here. +Regardless, it is essential for the launch of `micromark-rs` that extensions +are theoretically or practically possible. +The extensions below are listed from top to bottom from more important to less +important. -- [ ] (5) attention (strong, emphasis) -- [x] autolink -- [x] blank line -- [ ] (5) block quote -- [x] character escape -- [x] character reference -- [x] code (fenced) -- [x] code (indented) -- [x] code (text) -- [x] definition -- [x] hard break (escape) -- [x] hard break (trailing) -- [x] heading (atx) -- [x] heading (setext) -- [x] html (flow) -- [x] html (text) -- [ ] (3) label end -- [ ] (3) label start (image) -- [ ] (3) label start (link) -- [ ] (8) list -- [x] paragraph -- [x] thematic break +- [ ] (1) frontmatter (yaml, toml) (flow) + — [`micromark-extension-frontmatter`](https://github.com/micromark/micromark-extension-frontmatter) +- [ ] (3) autolink literal (GFM) (text) + — [`micromark-extension-gfm-autolink-literal`](https://github.com/micromark/micromark-extension-gfm-autolink-literal) +- [ ] (3) footnote (GFM) (flow, text) + — [`micromark-extension-gfm-footnote`](https://github.com/micromark/micromark-extension-gfm-footnote) +- [ ] (3) strikethrough (GFM) (text) + — [`micromark-extension-gfm-strikethrough`](https://github.com/micromark/micromark-extension-gfm-strikethrough) +- [ ] (5) table (GFM) (flow) + — [`micromark-extension-gfm-table`](https://github.com/micromark/micromark-extension-gfm-table) +- [ ] (1) task list item (GFM) (text) + — [`micromark-extension-gfm-task-list-item`](https://github.com/micromark/micromark-extension-gfm-task-list-item) +- [ ] (3) math (flow, text) + — [`micromark-extension-math`](https://github.com/micromark/micromark-extension-math) +- [ ] (8) directive (flow, text) + — [`micromark-extension-directive`](https://github.com/micromark/micromark-extension-directive) +- [ ] (8) expression (MDX) (flow, text) + — [`micromark-extension-mdx-expression`](https://github.com/micromark/micromark-extension-mdx-expression) +- [ ] (5) JSX (MDX) (flow, text) + — [`micromark-extension-mdx-jsx`](https://github.com/micromark/micromark-extension-mdx-jsx) +- [ ] (3) ESM (MDX) (flow) + — [`micromark-extension-mdxjs-esm`](https://github.com/micromark/micromark-extension-mdxjs-esm) +- [ ] (1) tagfilter (GFM) (n/a, renderer) + — [`micromark-extension-gfm-tagfilter`](https://github.com/micromark/micromark-extension-gfm-tagfilter) -### Content types +#### After -- [ ] (8) container - - [ ] block quote - - [ ] list -- [x] flow - - [x] blank line - - [x] code (fenced) - - [x] code (indented) - - [x] definition - - [x] heading (atx) - - [x] heading (setext) - - [x] html (flow) - - [x] paragraph - - [x] thematic break -- [ ] (8) text - - [ ] attention (strong, emphasis) (text) - - [x] autolink - - [x] character escape - - [x] character reference - - [x] code (text) - - [x] hard break (escape) - - [x] hard break (trailing) - - [x] html (text) - - [ ] label end - - [ ] label start (image) - - [ ] label start (link) -- [x] string - - [x] character escape - - [x] character reference +- [ ] (8) After all extensions, including MDX, are done, see if we can integrate + this with SWC to compile MDX ### Done @@ -234,37 +267,3 @@ cargo doc --document-private-items - [x] (1) Add docs to `normalize_identifier` - [x] (1) Add docs for how references and definitions match - [x] (1) Add module docs to parser - -### Extensions - -The main thing here is is to figure out if folks could extend from the outside -with their own code, or if we need to maintain it all here. -Regardless, it is essential for the launch of `micromark-rs` that extensions -are theoretically or practically possible. -The extensions below are listed from top to bottom from more important to less -important. - -- [ ] (1) frontmatter (yaml, toml) (flow) - — [`micromark-extension-frontmatter`](https://github.com/micromark/micromark-extension-frontmatter) -- [ ] (3) autolink literal (GFM) (text) - — [`micromark-extension-gfm-autolink-literal`](https://github.com/micromark/micromark-extension-gfm-autolink-literal) -- [ ] (3) footnote (GFM) (flow, text) - — [`micromark-extension-gfm-footnote`](https://github.com/micromark/micromark-extension-gfm-footnote) -- [ ] (3) strikethrough (GFM) (text) - — [`micromark-extension-gfm-strikethrough`](https://github.com/micromark/micromark-extension-gfm-strikethrough) -- [ ] (5) table (GFM) (flow) - — [`micromark-extension-gfm-table`](https://github.com/micromark/micromark-extension-gfm-table) -- [ ] (1) task list item (GFM) (text) - — [`micromark-extension-gfm-task-list-item`](https://github.com/micromark/micromark-extension-gfm-task-list-item) -- [ ] (3) math (flow, text) - — [`micromark-extension-math`](https://github.com/micromark/micromark-extension-math) -- [ ] (8) directive (flow, text) - — [`micromark-extension-directive`](https://github.com/micromark/micromark-extension-directive) -- [ ] (8) expression (MDX) (flow, text) - — [`micromark-extension-mdx-expression`](https://github.com/micromark/micromark-extension-mdx-expression) -- [ ] (5) JSX (MDX) (flow, text) - — [`micromark-extension-mdx-jsx`](https://github.com/micromark/micromark-extension-mdx-jsx) -- [ ] (3) ESM (MDX) (flow) - — [`micromark-extension-mdxjs-esm`](https://github.com/micromark/micromark-extension-mdxjs-esm) -- [ ] (1) tagfilter (GFM) (n/a, renderer) - — [`micromark-extension-gfm-tagfilter`](https://github.com/micromark/micromark-extension-gfm-tagfilter) |