You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tests/dummy/app/pods/docs/quickstart/template.md
+45-51Lines changed: 45 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,32 @@ This quickstart guide will get you going with a docs site for your brand new add
4
4
5
5
1.**Install the addon.**
6
6
7
-
8
-
```
9
-
ember install ember-learn/ember-cli-addon-docs
10
-
```
7
+
```
8
+
ember install ember-learn/ember-cli-addon-docs
9
+
```
11
10
12
11
2.**Add the docs route.** Open `tests/dummy/app/router.js` and add a route named `docs`. Go ahead and make it nested, since this is where you'll be defining additional documentation pages.
3.**Create your app skeleton.**Open your application template and add the DocsNavbar component, customizing its properties for your project. You can also add the global keyboard shortcuts component (use `?` to show the help window). Here's our application template:
21
+
3.**Create your app skeleton.**You can add the global keyboard shortcuts component to enable keyboard navigation around your docs site (use `?` to show the help window). Here's our application template:
5.**Fill out the index of your docs page.** We called it Overview but you can call it whatever you want. Since Addon Docs supports markdown templates out of the box, we can make this a Markdown file.
8.**Add more docs pages.** It's up to you how to structure your docs - use the Snippet, Viewer and Demo components to help you write your documentation. Let's add another page to ours: we'll add the route, link to our docs viewer, and the actual template.
0 commit comments