Skip to content

Commit e255ac8

Browse files
mansonamansona
committed
fix docs
1 parent 20ca9f2 commit e255ac8

21 files changed

+239
-251
lines changed

‎tests/dummy/app/router.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import EmberRouter from '@ember/routing/router';
1+
import AddonDocsRouter, { docsRoute } from "ember-cli-addon-docs/router";
22
import config from 'dummy/config/environment';
33

4-
export default class Router extends EmberRouter {
4+
export default class Router extends AddonDocsRouter {
55
location = config.locationType;
66
rootURL = config.rootURL;
77
}

‎tests/dummy/app/templates/docs.hbs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
{{#viewer.nav as |nav|}}
44
{{nav.section "Introduction"}}
5-
{{nav.item "This project" "docs.index"}}
5+
<nav.item @label="This project" @route="docs.index" />
66

77
{{nav.section "Layout Components"}}
8-
{{nav.item "Aside" "docs.components.es-aside"}}
9-
{{nav.item "Footer" "docs.components.es-footer"}}
10-
{{nav.item "Header" "docs.components.es-header"}}
11-
{{nav.item "Main" "docs.components.es-main"}}
8+
<nav.item @label="Aside" @route="docs.components.es-aside" />
9+
<nav.item @label="Footer" @route="docs.components.es-footer" />
10+
<nav.item @label="Header" @route="docs.components.es-header" />
11+
<nav.item @label="Main" @route="docs.components.es-main" />
1212

1313
{{nav.section "Components"}}
14-
{{nav.item "Accordion" "docs.components.es-accordion"}}
15-
{{nav.item "Form" "docs.components.es-form"}}
16-
{{nav.item "List" "docs.components.es-ulist"}}
17-
{{nav.item "Blog heading" "docs.components.es-blog-heading"}}
18-
{{nav.item "Button" "docs.components.es-button"}}
19-
{{nav.item "Buttonbar" "docs.components.es-buttonbar"}}
20-
{{nav.item "Card" "docs.components.es-card"}}
21-
{{nav.item "Codesample" "docs.components.es-codesample"}}
22-
{{nav.item "Datatable" "docs.components.es-datatable"}}
23-
{{nav.item "Heading" "docs.components.es-heading"}}
24-
{{nav.item "Navbar" "docs.components.es-navbar"}}
25-
{{nav.item "Note" "docs.components.es-note"}}
26-
{{nav.item "Search" "docs.components.es-search"}}
14+
<nav.item @label="Accordion" @route="docs.components.es-accordion"/>
15+
<nav.item @label="Form" @route="docs.components.es-form"/>
16+
<nav.item @label="List" @route="docs.components.es-ulist"/>
17+
<nav.item @label="Blog heading" @route="docs.components.es-blog-heading"/>
18+
<nav.item @label="Button" @route="docs.components.es-button"/>
19+
<nav.item @label="Buttonbar" @route="docs.components.es-buttonbar"/>
20+
<nav.item @label="Card" @route="docs.components.es-card"/>
21+
<nav.item @label="Codesample" @route="docs.components.es-codesample"/>
22+
<nav.item @label="Datatable" @route="docs.components.es-datatable"/>
23+
<nav.item @label="Heading" @route="docs.components.es-heading"/>
24+
<nav.item @label="Navbar" @route="docs.components.es-navbar"/>
25+
<nav.item @label="Note" @route="docs.components.es-note"/>
26+
<nav.item @label="Search" @route="docs.components.es-search"/>
2727
{{/viewer.nav}}
2828

2929
{{#viewer.main}}

‎tests/dummy/app/templates/docs/components/es-accordion.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,23 @@
11
# Accordion
22

3-
{{#docs-demo as |demo|}}
4-
{{#demo.example name='es-accordion.hbs'}}
5-
{{#es-accordion as |accordionState|}}
6-
{{#es-accordion/es-item
7-
title="JavaScript Modules API"
8-
status="shipped"
9-
accordionItemIndex=0
10-
accordionState=accordionState}}
3+
<DocsDemo as |demo|>
4+
<demo.example @name="es-accordion.hbs">
5+
<EsAccordion as |accordionState|>
6+
<EsAccordion::EsItem @title="JavaScript Modules API" @status="shipped" @accordionItemIndex={{0}} @accordionState={{accordionState}}>
117
<p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Aut nisi culpa magnam quam sed exercitationem alias corrupti aspernatur illo nobis eos dicta esse quasi assumenda officiis nostrum, impedit voluptates commodi.</p>
12-
{{/es-accordion/es-item}}
8+
</EsAccordion::EsItem>
139

14-
{{#es-accordion/es-item
15-
title="Module Unification"
16-
status="inProgress"
17-
accordionItemIndex=1
18-
accordionState=accordionState}}
10+
<EsAccordion::EsItem @title="Module Unification" @status="inProgress" @accordionItemIndex={{1}} @accordionState={{accordionState}}>
1911
<p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Aut nisi culpa magnam quam sed exercitationem alias corrupti aspernatur illo nobis eos dicta esse quasi assumenda officiis nostrum, impedit voluptates commodi.</p>
20-
{{/es-accordion/es-item}}
12+
</EsAccordion::EsItem>
2113

22-
{{#es-accordion/es-item
23-
title="Code Splitting"
24-
status="rfcSubmitted"
25-
accordionItemIndex=2
26-
accordionState=accordionState}}
14+
<EsAccordion::EsItem @title="Code Splitting" @status="rfcSubmitted" @accordionItemIndex={{2}} @accordionState={{accordionState}}>
2715
<p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Aut nisi culpa magnam quam sed exercitationem alias corrupti aspernatur illo nobis eos dicta esse quasi assumenda officiis nostrum, impedit voluptates commodi.</p>
28-
{{/es-accordion/es-item}}
16+
</EsAccordion::EsItem>
2917

30-
{{/es-accordion}}
31-
{{/demo.example}}
32-
{{demo.snippet 'es-accordion.hbs'}}
33-
{{/docs-demo}}
18+
</EsAccordion>
19+
</demo.example>
20+
<demo.snippet @name="es-accordion.hbs" />
21+
</DocsDemo>
3422

3523
{{docs-note}}

‎tests/dummy/app/templates/docs/components/es-aside.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Aside
22

3-
{{#docs-demo as |demo|}}
4-
{{#demo.example name='es-aside.hbs'}}
3+
<DocsDemo as |demo|>
4+
<demo.example @name="es-aside.hbs">
55
{{es-aside}}
6-
{{/demo.example}}
7-
{{demo.snippet 'es-aside.hbs'}}
8-
{{/docs-demo}}
6+
</demo.example>
7+
<demo.snippet @name='es-aside.hbs' />
8+
</DocsDemo>
99

1010
{{docs-note}}

‎tests/dummy/app/templates/docs/components/es-blog-heading.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,31 @@
22

33
## Regular Post
44

5-
{{#docs-demo as |demo|}}
6-
{{#demo.example name='es-blog-heading.hbs'}}
5+
<DocsDemo as |demo|>
6+
<demo.example @name="es-blog-heading.hbs">
77
<EsBlogHeading
88
@author='Sara Poster'
99
@postDate='03-20-2018'
1010
@postUrl='https://emberjs.com/blog'
1111
@postTitle='Pretty Awesome Blog Post'
1212
/>
13-
{{/demo.example}}
14-
{{demo.snippet 'es-blog-heading.hbs'}}
15-
{{/docs-demo}}
13+
</demo.example>
14+
<demo.snippet @name="es-blog-heading.hbs" />
15+
</DocsDemo>
1616

1717
## Guest Post
1818

19-
{{#docs-demo as |demo|}}
20-
{{#demo.example name='es-blog-heading-guest.hbs'}}
19+
<DocsDemo as |demo|>
20+
<demo.example @name="es-blog-heading-guest.hbs">
2121
<EsBlogHeading
2222
@author='Sara Poster'
2323
@postDate='03-20-2018'
2424
@postUrl='https://emberjs.com/blog'
2525
@postTitle='Pretty Awesome Blog Post'
2626
@isGuestPost=true
2727
/>
28-
{{/demo.example}}
29-
{{demo.snippet 'es-blog-heading-guest.hbs'}}
30-
{{/docs-demo}}
28+
</demo.example>
29+
<demo.snippet @name="es-blog-heading-guest.hbs" />
30+
</DocsDemo>
3131

3232
{{docs-note}}

‎tests/dummy/app/templates/docs/components/es-button.md

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,79 @@
44

55
Simplest use case: a button with text in it, telling the user what to do.
66

7-
{{#docs-demo as |demo|}}
8-
{{#demo.example name="es-button.hbs"}}
9-
{{es-button label="click me"}}
10-
{{/demo.example}}
11-
{{demo.snippet 'es-button.hbs'}}
12-
{{/docs-demo}}
7+
<DocsDemo as |demo|>
8+
<demo.example @name="es-button.hbs">
9+
<EsButton @label="click me" />
10+
</demo.example>
11+
<demo.snippet @name="es-button.hbs" />
12+
</DocsDemo>
1313

1414

1515
Also supported- block use:
16-
{{#docs-demo as |demo|}}
17-
{{#demo.example name='es-button-has-block.hbs'}}
18-
{{#es-button}}
16+
<DocsDemo as |demo|>
17+
<demo.example @name="es-button-has-block.hbs">
18+
<EsButton>
1919
click me <span>🐹</span>
20-
{{/es-button}}
21-
{{/demo.example}}
22-
{{demo.snippet 'es-button-has-block.hbs'}}
23-
{{/docs-demo}}
20+
</EsButton>
21+
</demo.example>
22+
<demo.snippet @name="es-button-has-block.hbs" />
23+
</DocsDemo>
2424

2525
To toggle the 'disabled' property, set 'isDisabled' to true
26-
{{#docs-demo as |demo|}}
27-
{{#demo.example name='es-button-disabled.hbs'}}
28-
{{es-button label="click me" isDisabled=true}}
29-
{{/demo.example}}
30-
{{demo.snippet 'es-button-disabled.hbs'}}
31-
{{/docs-demo}}
26+
<DocsDemo as |demo|>
27+
<demo.example @name="es-button-disabled.hbs">
28+
<EsButton @label="click me" @isDisabled={{true}} />
29+
</demo.example>
30+
<demo.snippet @name="es-button-disabled.hbs" />
31+
</DocsDemo>
3232

3333
## Styles
3434

3535
Outline button style:
36-
{{#docs-demo as |demo|}}
37-
{{#demo.example name='es-button-light.hbs'}}
38-
{{es-button label="click me" isDark=false}}
39-
{{/demo.example}}
40-
{{demo.snippet 'es-button-light.hbs'}}
41-
{{/docs-demo}}
36+
<DocsDemo as |demo|>
37+
<demo.example @name="es-button-light.hbs">
38+
<EsButton @label="click me" @isDark={{false}} />
39+
</demo.example>
40+
<demo.snippet @name="es-button-light.hbs" />
41+
</DocsDemo>
4242

4343
Smaller button:
44-
{{#docs-demo as |demo|}}
45-
{{#demo.example name='es-button-tiny.hbs'}}
46-
{{es-button label="click me" isTiny=true}}
47-
{{/demo.example}}
48-
{{demo.snippet 'es-button-tiny.hbs'}}
49-
{{/docs-demo}}
44+
<DocsDemo as |demo|>
45+
<demo.example @name="es-button-tiny.hbs">
46+
<EsButton @label="click me" @isTiny={{true}} />
47+
</demo.example>
48+
<demo.snippet @name="es-button-tiny.hbs" />
49+
</DocsDemo>
5050

5151
Less Padding:
52-
{{#docs-demo as |demo|}}
53-
{{#demo.example name='es-button-dense.hbs'}}
54-
{{es-button label="click me" isDark=true isDense=true}}
55-
{{/demo.example}}
56-
{{demo.snippet 'es-button-dense.hbs'}}
57-
{{/docs-demo}}
52+
<DocsDemo as |demo|>
53+
<demo.example @name="es-button-dense.hbs">
54+
<EsButton @label="click me" @isDark={{true}} @isDense={{true}} />
55+
</demo.example>
56+
<demo.snippet @name="es-button-dense.hbs" />
57+
</DocsDemo>
5858

5959
Full-width button:
60-
{{#docs-demo as |demo|}}
61-
{{#demo.example name='es-button-block.hbs'}}
62-
{{es-button label="click me" isBlock=true}}
63-
{{/demo.example}}
64-
{{demo.snippet 'es-button-block.hbs'}}
65-
{{/docs-demo}}
60+
<DocsDemo as |demo|>
61+
<demo.example @name="es-button-block.hbs">
62+
<EsButton @label="click me" @isBlock={{true}} />
63+
</demo.example>
64+
<demo.snippet @name="es-button-block.hbs" />
65+
</DocsDemo>
6666

6767
## Accessibility
6868

6969
Since we're using the native HTML button element and requiring a label value to be provided, the component itself is accesible as it is.
7070

7171
If you are going to put an icon in the button, then you will need to set an aria-label property on the button:
72-
{{#docs-demo as |demo|}}
73-
{{#demo.example name='es-button-icon.hbs'}}
74-
{{#es-button ariaLabel="Hamster Secrets" title="Hamster Secrets"}}
72+
<DocsDemo as |demo|>
73+
<demo.example @name="es-button-icon.hbs">
74+
<EsButton @ariaLabel="Hamster Secrets" @title="Hamster Secrets">
7575
🐹
76-
{{/es-button}}
77-
{{/demo.example}}
78-
{{demo.snippet 'es-button-icon.hbs'}}
79-
{{/docs-demo}}
76+
</EsButton>
77+
</demo.example>
78+
<demo.snippet @name="es-button-icon.hbs" />
79+
</DocsDemo>
8080

8181
## Other Uses
8282

‎tests/dummy/app/templates/docs/components/es-buttonbar.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Button Bar
22

33
This component is not yet implemented
4-
{{#docs-demo as |demo|}}
5-
{{#demo.example name='es-buttonbar'}}
4+
<DocsDemo as |demo|>
5+
<demo.example @name="es-buttonbar">
66
<EsButtonbar />
7-
{{/demo.example}}
8-
{{demo.snippet 'es-buttonbar'}}
9-
{{/docs-demo}}
7+
</demo.example>
8+
<demo.snippet @name="es-buttonbar" />
9+
</DocsDemo>
1010

1111
{{docs-note}}

‎tests/dummy/app/templates/docs/components/es-card.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Card
22

3-
{{#docs-demo as |demo|}}
4-
{{#demo.example name='es-card'}}
5-
{{#es-card}}
3+
<DocsDemo as |demo|>
4+
<demo.example @name="es-card">
5+
<EsCard>
66
This is a card
7-
{{/es-card}}
8-
{{/demo.example}}
9-
{{demo.snippet 'es-card'}}
10-
{{/docs-demo}}
7+
</EsCard>
8+
</demo.example>
9+
<demo.snippet @name="es-card" />
10+
</DocsDemo>
1111

12-
{{#docs-demo as |demo|}}
13-
{{#demo.example name='es-card-has-border'}}
14-
{{#es-card hasBorder=true}}
12+
<DocsDemo as |demo|>
13+
<demo.example @name="es-card-has-border">
14+
<EsCard @hasBorder={{true}}>
1515
This is a card
16-
{{/es-card}}
17-
{{/demo.example}}
18-
{{demo.snippet 'es-card-has-border'}}
19-
{{/docs-demo}}
16+
</EsCard>
17+
</demo.example>
18+
<demo.snippet @name="es-card-has-border" />
19+
</DocsDemo>
2020

2121
{{docs-note}}

‎tests/dummy/app/templates/docs/components/es-codesample.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Code Sample
22

33
This component is not yet implemented
4-
{{#docs-demo as |demo|}}
5-
{{#demo.example name='es-codesample'}}
4+
<DocsDemo as |demo|>
5+
<demo.example @name="es-codesample">
66
{{es-codesample}}
7-
{{/demo.example}}
8-
{{demo.snippet 'es-codesample'}}
9-
{{/docs-demo}}
7+
</demo.example>
8+
<demo.snippet @name="es-codesample" />
9+
</DocsDemo>
1010

1111
{{docs-note}}

‎tests/dummy/app/templates/docs/components/es-datatable.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Data Table
22

33
This component is not yet implemented
4-
{{#docs-demo as |demo|}}
5-
{{#demo.example name='es-datatable'}}
4+
<DocsDemo as |demo|>
5+
<demo.example @name="es-datatable">
66
{{es-datatable}}
7-
{{/demo.example}}
8-
{{demo.snippet 'es-datatable'}}
9-
{{/docs-demo}}
7+
</demo.example>
8+
<demo.snippet @name="es-datatable" />
9+
</DocsDemo>
1010

1111
{{docs-note}}

0 commit comments

Comments
 (0)