Skip to content

Commit dddf0f5

Browse files
committed
Rename to 'Markdown templates' + use components for the marketing/demo page
1 parent 826471c commit dddf0f5

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

tests/dummy/app/pods/docs/quickstart/template.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This quickstart guide will get you started with a docs site for your brand new
44
addon. After completion you will have a docs homepage, a docs subpage named
5-
`usage`, an automatically generated API reference and a marketing
6-
homepage you can use to promote your addon.
5+
`usage`, an automatically generated API reference and a nice looking
6+
marketing/demo page you can use to promote your addon.
77

88
1. **Install Addon Docs.**
99

@@ -46,7 +46,7 @@ all docs pages in your site.
4646
{{/docs-viewer}}
4747
{{/docs-snippet}}
4848

49-
4. **Create your documentation sources.** Documentation sources contain the
49+
4. **Create your Markdown templates.** Markdown templates contain the actual
5050
actual documentation for your addon and live in the folder
5151
`tests/dummy/app/templates/docs`. Since Addon Docs supports Markdown out
5252
of the box we will create two `.md` files (one for your docs `index` and one
@@ -64,14 +64,26 @@ for the `usage` page).
6464
So easy to use, sweet!
6565
{{/docs-snippet}}
6666

67-
5. **Create your marketing homepage**. Create a new template that will function
68-
as the marketing homepage for your new addon.
67+
5. **Create your marketing homepage**. Addon Docs comes with a set of
68+
components that take out all the hard work normally required for creating
69+
good looking marketing/demo pages. Creating a template with the following
70+
components will instantly give your main page a docs site a navbar, a nice hero
71+
and a snippet-ready demo container.
6972

7073
{{#docs-snippet name='quickstart-marketing-index.hbs' title='tests/dummy/app/templates/index.hbs'}}
71-
{{#link-to 'docs'}}Docs{{/link-to}}
72-
{{#link-to 'docs.api'}}API Reference{{/link-to}}
73-
74-
My addon marketing page with mind-blowing demo.
74+
{{docs-navbar}}
75+
76+
{{docs-hero
77+
logo='ember'
78+
slimHeading='My'
79+
strongHeading='Addon'
80+
byline='My addon demo/marketing page.'}}
81+
82+
{{#docs-demo as |demo|}}
83+
{{#demo.example name='my-demo.hbs'}}
84+
<p>Make sure to read up on the DocsDemo component before building out this page.</p>
85+
{{/demo.example}}
86+
{{/docs-demo}}
7587
{{/docs-snippet}}
7688

7789
6. **Add a 404 route.** Add the following route to the end of your router and
@@ -95,8 +107,8 @@ create the associated template.
95107
used for the `Usage` page in above instructions:
96108

97109
- create a docs subroute
98-
- add a navigation item to the `docs` template
99-
- create a new documentation source file (using Markdown, HtmlBars, etc.)
110+
- add a corresponding navigation item to the `docs` template
111+
- create a corresponding Markdown template
100112

101113
## Optional
102114

0 commit comments

Comments
 (0)