summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSamy Pesse <samypesse@gmail.com>2016-09-22 10:54:54 +0200
committerSamy Pesse <samypesse@gmail.com>2016-09-22 10:54:54 +0200
commit45c54d0cd72509a65c42aaa95194ac1c9cda64c8 (patch)
tree08802e4b6d1eacdf8a371f7d3cef103662a67fb3 /docs
parentf49089a7d3a6fd5523c71e06e5e0d132bb6ffd9a (diff)
downloadgitbook-45c54d0cd72509a65c42aaa95194ac1c9cda64c8.zip
gitbook-45c54d0cd72509a65c42aaa95194ac1c9cda64c8.tar.gz
gitbook-45c54d0cd72509a65c42aaa95194ac1c9cda64c8.tar.bz2
Base tree rendering for summary
Diffstat (limited to 'docs')
-rw-r--r--docs/api/components.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/api/components.md b/docs/api/components.md
new file mode 100644
index 0000000..77f1bb1
--- /dev/null
+++ b/docs/api/components.md
@@ -0,0 +1,12 @@
+
+
+
+### Roles
+
+| Role | Description | Props |
+| ---- | ----------- | ----- |
+| `summary:container` | DIV container for the whole summary | `{ summary: Summary }` |
+| `summary:parts` | DIV container for summary's parts | `{ parts: List<SummaryPart> }` |
+| `summary:part` | DIV for a specific part | `{ part: SummaryPart }` |
+| `summary:articles` | UL container for a part's articles | `{ articles: List<SummaryArticle> }` |
+| `summary:article` | LI for a specific article | `{ article: SummaryArticle }` |