Skip to content

Commit 1804e15

Browse files
authored
Merge pull request #489 from rackerlabs/phase3-docs-part1
docs(*): update supporting files for upcoming docs updates
2 parents e36dad6 + 7e2f6e4 commit 1804e15

File tree

9 files changed

+285
-149
lines changed

9 files changed

+285
-149
lines changed

docs/_data/nav.json5

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
{ label: 'Checkboxes', path: 'checkboxes' },
2424
{ label: 'Choice Tiles', path: 'choice-tiles' },
2525
{ label: 'Dropdown Select', path: 'dropdown-select' },
26-
//{ label: 'Colors', path: 'colors' },
2726
{ label: 'Files', path: 'files' },
2827
{ label: 'Grid', path: 'grid' },
2928
{ label: 'Icons', path: 'icons' },
@@ -42,8 +41,8 @@
4241
{ label: 'Menus', path: 'menus' },
4342
{ label: 'Modals', path: 'modals' },
4443
{ label: 'Navigation', path: 'navigation' },
45-
{ label: 'Panels', path: 'panels' },
4644
{ label: 'Pagination', path: 'pagination' },
45+
{ label: 'Panels', path: 'panels' },
4746
{ label: 'Pills', path: 'pills' },
4847
{ label: 'Popovers', path: 'popovers' },
4948
{ label: 'Radios', path: 'radios' },
@@ -105,15 +104,4 @@
105104
{ label: '<hx-tooltip>', path: 'hx-tooltip' },
106105
],
107106
},
108-
109-
/* COMING SOON...
110-
{
111-
label: 'API',
112-
path: 'API',
113-
children: [
114-
{ label: 'HXElement', path: 'HXElement' },
115-
...
116-
],
117-
}
118-
*/
119107
]

docs/_templates/application.njk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222
</nav>
2323

2424
{% block layout %}
25-
<main role="main" id="content" class="hxBox hxMd">
25+
<main role="main" id="content">
2626
{% block content %}
2727
{# page content goes here #}
2828
{% endblock %}
2929
</main>
3030

31-
<aside class="hxSiderail hxBox hxMd">
31+
<aside class="hxSiderail">
3232
{% block sidebar %}
3333
{% include 'partials/sidebar.njk' %}
3434
{% endblock %}

docs/_templates/component.njk

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
{% extends 'application.njk' %}
22

33
{% block layout %}
4-
<main id="content" class="hxBox hxMd component-content {{contentClasses}}">
4+
<main id="content" class="component-content {{contentClasses}}">
55
<header>
6+
{% block breadcrumbs %}
7+
{# breadcrumbs go here (optional) #}
8+
{% endblock %}
9+
610
<h1>
711
{{ page.title }}
812
{% include 'partials/min-version.njk' %}
913
</h1>
1014

15+
{% if page.beta %}
16+
<hx-alert type="warning" status="BETA" persist>
17+
This component is not recommended for production use.
18+
</hx-alert>
19+
{% endif %}
20+
1121
{% block page_header %}
1222
{# extra header content goes here #}
1323
{% endblock %}
@@ -21,7 +31,7 @@
2131
{% include 'partials/see-also.njk' %}
2232
{% endif %}
2333
</main>
24-
<aside class="hxSiderail hxBox hxMd">
34+
<aside class="hxSiderail">
2535
{% include 'partials/sidebar.njk' %}
2636
</aside>
2737
{% endblock %}

docs/_templates/element.njk

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
{% extends 'application.njk' %}
22

33
{% block layout %}
4-
<main id="content" class="hxBox hxMd">
4+
<main id="content" class="element-content">
55
<header>
6+
{% block breadcrumbs %}
7+
{# breadcrumbs go here (optional) #}
8+
{% endblock %}
9+
610
<h1>
711
{{ page.title }}
812
{% include 'partials/min-version.njk' %}
@@ -58,7 +62,7 @@
5862
{% endif %}
5963
</main>
6064

61-
<aside class="hxSiderail hxBox hxMd">
65+
<aside class="hxSiderail">
6266
<header>
6367
<h1 class="hxHeading-4">On this page:</h1>
6468
</header>

docs/_templates/guide.njk

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
{% extends 'application.njk' %}
22

33
{% block layout %}
4-
<main id="content" class="hxBox hxMd">
4+
<main id="content" class="guide-content">
55
<header>
6+
{% block breadcrumbs %}
7+
{# breadcrumbs go here (optional) #}
8+
{% endblock %}
9+
610
<h1>{{ page.title }}</h1>
711

812
{% block page_header %}
@@ -18,7 +22,7 @@
1822
{% include 'partials/see-also.njk' %}
1923
{% endif %}
2024
</main>
21-
<aside class="hxSiderail hxBox hxMd">
25+
<aside class="hxSiderail">
2226
{% include 'partials/sidebar.njk' %}
2327
</aside>
2428
{% endblock %}

docs/_templates/test.njk

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% extends 'application.njk' %}
22

33
{% block layout %}
4-
<main id="content" class="hxBox hxLg test-content {{contentClasses}}">
4+
<main id="content" class="test-content {{contentClasses}}">
55
<header>
66
{% block breadcrumbs %}
77
{# breadcrumbs go here #}
@@ -17,9 +17,17 @@
1717
{% block content %}
1818
{# freeform page content goes here #}
1919
{% endblock %}
20+
21+
<div class="banner warning">
22+
<hx-icon type="exclamation-triangle" class="banner__icon"></hx-icon>
23+
<div class="banner__body">
24+
<b>UI TESTING:</b>
25+
Do not replicate anything on this page within your application.
26+
</div>
27+
</div>
2028
</main>
2129

22-
<aside class="hxSiderail hxBox hxMd">
30+
<aside class="hxSiderail">
2331
<header>
2432
<h1 class="hxHeading-4">On this page:</h1>
2533
</header>

0 commit comments

Comments
 (0)