Add docs on new parse_text function

executablebooks · Feb 28, 2020 · d37c12d · d37c12d
1 parent c5b3b95
commit d37c12d
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/using/use_api.md b/docs/using/use_api.md
@@ -6,6 +6,24 @@ MyST-Parser may be used as an API *via* the `myst_parser` package.
 The raw text is first parsed to syntax 'tokens',
 then these are converted to other formats using 'renderers'.
 
+The simplest way to parse text is using:
+
+```python
+from myst_parser import parse_text
+parse_text("some *text*", "html")
+```
+
+```html
+'<p>some <em>text</em></p>\n'
+```
+
+The output type can be one of:
+
+- `dict` (a.k.a ast)
+- `html`
+- `docutils`
+- `sphinx`
+
 ## Convert Text to Tokens
 
 To convert some text to tokens: