Skip to content

Commit 55fd87c

Browse files
CITguyCITguy
authored
Merge pull request #129 from rackerlabs/update-install-guide
Convert "Guides > Installing" to "Guides > Getting Started"
2 parents cc150b2 + 3004b4f commit 55fd87c

File tree

10 files changed

+76
-230
lines changed

10 files changed

+76
-230
lines changed

‎docs/_data/nav.json5‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
label: 'Guides',
44
path: 'guides',
55
children: [
6-
{ label: 'Installing', path: 'install' },
6+
{ label: 'Getting Started', path: 'getting-started' },
77
]
88
},
99

‎docs/_templates/partials/after_footer.njk‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,5 @@
1616
crossorigin="anonymous"></script>
1717

1818
<script src="https://unpkg.com/[email protected]/dist/vue.js"></script>
19-
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
2019
<script src="dist/scripts/helix-ui.browser.js"></script>
2120
<script src="docs.js"></script>

‎docs/_templates/partials/head.njk‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@
66

77
<link rel="shortcut icon" href="images/favicon.png">
88

9-
<!-- Bootstrap 3 -->
10-
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
11-
rel="stylesheet"
12-
integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u"
13-
crossorigin="anonymous">
14-
159
<link rel="stylesheet" href="dist/styles/helix-ui.css">
1610
<link rel="stylesheet" href="docs.css">
1711

‎docs/components/buttons/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ <h2 class="hxSectionTitle" id="button-sizing">Button Sizing</h2>
5353

5454
<section data-visreg="button-states">
5555
<h2 class="hxSectionTitle" id="button-states">Button States</h2>
56-
<table class="table">
56+
<table class="hxTable">
5757
<tbody>
5858
<tr>
5959
<td>Default</td>

‎docs/components/layouts/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Layouts
33
also:
4+
guides/getting-started: Getting Started
45
components/box: Box
56
components/grid: Grid
67
---

‎docs/guides/getting-started/index.html‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Getting Started with HelixUI
3+
---
4+
{% extends 'guide.njk' %}
5+
{% block content %}
6+
<section>
7+
<p>
8+
This guide is intented to help developers initialize a Helix application.
9+
</p>
10+
</section>
11+
12+
<section><!-- Install from NPM -->
13+
<h2 class="hxSectionTitle" id="install">Step 1: Install HelixUI via npm or Yarn</h2>
14+
<p>
15+
HelixUI is registered as a package on <a href="https://www.npmjs.com/">npm</a>.
16+
You can install the latest version with the npm CLI command:
17+
</p>
18+
{% code "bash" %}
19+
npm install --save-dev helix-ui
20+
{% endcode %}
21+
22+
<p>
23+
Alternatively, you can use the <a href="https://yarnpkg.com">Yarn</a>
24+
CLI command:
25+
</p>
26+
{% code "bash" %}
27+
yarn add helix-ui
28+
{% endcode %}
29+
30+
<p>
31+
Both approaches install HelixUI in the <code>node_modules/</code> directory.
32+
</p>
33+
</section>
34+
35+
<section><!-- Choose a Layout -->
36+
<h2 class="hxSectionTitle" id="choose-layout">Step 2: Choose a Layout</h2>
37+
<p>
38+
Building a Helix application begins with choosing a layout.
39+
HelixUI provides two supported layouts from which you can choose.
40+
</p>
41+
<ol>
42+
<li>
43+
<a href="components/layouts/#vertical-layout">Vertical Layout</a>
44+
<ul>
45+
<li>Lengthy content pushes the footer below the fold.</li>
46+
</ul>
47+
</li>
48+
<li>
49+
<a href="components/layouts/#horizontal-layout">Horizontal Layout</a>
50+
<ul>
51+
<li>The footer is always visible.</li>
52+
</ul>
53+
</li>
54+
</ol>
55+
</section>
56+
57+
<section><!-- Create Content -->
58+
<h2 class="hxSectionTitle" id="add-content">Step 3: Add Content</h2>
59+
<p>
60+
Add content and interactivity to your application using components.
61+
Components contain interactive demos and information for various
62+
interaction patterns.
63+
</p>
64+
<ol>
65+
<li>Choose a component from the navigation on the left.</li>
66+
<li>Check the "See Also" section on the component page for more information.</li>
67+
</ol>
68+
</section>
69+
{% endblock %}

‎docs/guides/install/index.html‎

Lines changed: 0 additions & 217 deletions
This file was deleted.

‎docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ <h1 class="hxPageTitle">HelixUI</h1>
99
<section class="hxSpan-12-xs hxSpan-6-md">
1010
<h3 class="hxSubSectionTitle">Getting Started</h3>
1111
<p>
12-
To learn how to get HelixUI into your projects, check out the
13-
<a href="guides/install">install guide</a>.
12+
To learn how to build Helix applications, check out the
13+
<a href="guides/getting-started">Getting Started</a> guide.
1414
</p>
1515
</section>
1616
<section class="hxSpan-12-xs hxSpan-6-md">

‎test/regression/generateRegressionTests.js.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Generated by [AVA](https://ava.li).
1010
1111
`<section data-visreg="button-states">␊
1212
<h2 class="hxSectionTitle" id="button-states">Button States</h2>␊
13-
<table class="table">␊
13+
<table class="hxTable">␊
1414
<tbody>␊
1515
<tr>␊
1616
<td>Default</td>␊
@@ -85,7 +85,7 @@ Generated by [AVA](https://ava.li).
8585
8686
`<section data-visreg="button-states">␊
8787
<h2 class="hxSectionTitle" id="button-states">Button States</h2>␊
88-
<table class="table">␊
88+
<table class="hxTable">␊
8989
<tbody>␊
9090
<tr>␊
9191
<td>Default</td>␊

‎test/regression/generateRegressionTests.js.snap‎

-33 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)