Skip to content

Commit

Permalink
Merge pull request #63 from empress/document-toc
Browse files Browse the repository at this point in the history
add documentation for `toc` content type
  • Loading branch information
mansona authored Sep 25, 2021
2 parents ac158aa + c01b096 commit cbb1201
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,15 +104,15 @@ 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
```

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';
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit cbb1201

Please sign in to comment.