Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation for toc content type #63

Merged
merged 1 commit into from
Sep 25, 2021
Merged

add documentation for toc content type #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
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