summaryrefslogtreecommitdiffstats
path: root/docs/plugins/api.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/plugins/api.md')
-rw-r--r--docs/plugins/api.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/plugins/api.md b/docs/plugins/api.md
index c5a17b3..135f196 100644
--- a/docs/plugins/api.md
+++ b/docs/plugins/api.md
@@ -12,6 +12,14 @@ var value = book.config.get('title', 'Default Value');
// Resolve a filename to an absolute path
var filepath = book.resolve('README.md');
+
+// Render an inline markup string
+book.renderInline('markdown', 'This is **Markdown**')
+ .then(function(str) { ... })
+
+// Render a markup string (block mode)
+book.renderBlock('markdown', '* This is **Markdown**')
+ .then(function(str) { ... })
```
#### Output instance