From c01b09622f52659a631784a6a3a11378d1d14b55 Mon Sep 17 00:00:00 2001 From: Chris Manson Date: Sat, 25 Sep 2021 22:03:01 +0100 Subject: [PATCH] add documentation for `toc` content type --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 61b9ff1..211b515 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ export default DS.JSONAPIAdapter.extend({ ### Step 4 -Now we need to generate a Model so that we can request the data in a route: +Now we need to generate a Model so that we can request the data in a route: ```bash ember generate model content @@ -112,7 +112,7 @@ ember generate model content This `content` name matches the example we used above when using the `StaticSiteJson()` broccoli plugin. -Now you are able to query your data in an Ember Route: +Now you are able to query your data in an Ember Route: ```javascript import Route from '@ember/routing/route'; @@ -318,6 +318,8 @@ const jsonTree = new StaticSiteJson('content', { - Contains a simple html representation of the Markdown file - `description` - _optional_ - Contains the first 260 characters of the content of the file +- `toc` - _optional_ + - Contains an array of each heading of in the Markdown file, which can be used to make an internal Table of Contents for that page ### Markdown rendering configuration