better serving advice
This commit is contained in:
parent
50c662077b
commit
23e4bfe258
|
@ -12,12 +12,26 @@ This will serve your working library on `localhost:1313`. Whenever you make chan
|
||||||
|
|
||||||
## Publishing on Github Pages
|
## Publishing on Github Pages
|
||||||
|
|
||||||
The easiest way to host your pattern library so you have a link to share is to run the `host` command. This will build the library and push it to the local Github repository's `gh-pages` branch. Before you can use `host` you will need to commit any changes you made on the master branch. Otherwise there's nothing new to push over to the `gh-pages` branch.
|
There are three steps to hosting your library on Github Pages.
|
||||||
|
|
||||||
|
### 1. Edit the baseURL
|
||||||
|
|
||||||
|
Open up `config.toml` (at the root of your library project folder) and make sure `baseURL` matches your Github Pages URL.
|
||||||
|
|
||||||
|
```html
|
||||||
|
baseURL = "[your user name].github.io/[your library repo name]"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are having trouble working out your Github Pages URL, [this tool may help](https://drastudio.github.io/url-generator/).
|
||||||
|
|
||||||
|
### 2. Commit your latest changes
|
||||||
|
|
||||||
|
On the (default) master branch run:
|
||||||
|
|
||||||
{{<cmd>}}git commit -am "my commit message"{{</cmd>}}
|
{{<cmd>}}git commit -am "my commit message"{{</cmd>}}
|
||||||
|
|
||||||
This will ensure changes go through to `gh-pages`. Now you can run:
|
### 3. Run the `host` command
|
||||||
|
|
||||||
{{<cmd>}}npm run host{{</cmd>}}
|
{{<cmd>}}npm run host{{</cmd>}}
|
||||||
|
|
||||||
You should now be able to find a "live" version of your library at `github.io/[your username]/[your library repo name]`.
|
You should now be able to find a "live" version of your library at `[your user name].github.io/[your library repo name]`.
|
||||||
|
|
|
@ -192,7 +192,7 @@
|
||||||
|
|
||||||
<h2 id="publishing-on-github-pages">Publishing on Github Pages</h2>
|
<h2 id="publishing-on-github-pages">Publishing on Github Pages</h2>
|
||||||
|
|
||||||
<p>The easiest way to host your pattern library so you have a link to share is to run the <code>host</code> command. This will build the library and push it to the local Github repository’s <code>gh-pages</code> branch. Before you can use <code>host</code> you will need to commit any changes you made on the master branch:</p>
|
<p>The easiest way to host your pattern library so you have a link to share is to run the <code>host</code> command. This will build the library and push it to the local Github repository’s <code>gh-pages</code> branch. Before you can use <code>host</code> you will need to commit any changes you made on the master branch. Otherwise there’s nothing new to push over to the <code>gh-pages</code> branch.</p>
|
||||||
|
|
||||||
<pre class="cmd"><code>git commit -am "my commit message"</code></pre>
|
<pre class="cmd"><code>git commit -am "my commit message"</code></pre>
|
||||||
|
|
||||||
|
|
|
@ -64,7 +64,8 @@
|
||||||
{{ block "main" . }}
|
{{ block "main" . }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
<footer role="contentinfo">
|
<footer role="contentinfo">
|
||||||
By Heydon Pickering
|
Powered by <strong>Infusion</strong>, a <strong>The Paciello Group</strong> project<br>
|
||||||
|
For general enquiries, contact us on info@paciellogroup.com
|
||||||
</footer>
|
</footer>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -224,6 +224,8 @@ th:empty {
|
||||||
|
|
||||||
[role="contentinfo"] {
|
[role="contentinfo"] {
|
||||||
font-size: 0.85rem;
|
font-size: 0.85rem;
|
||||||
|
margin-top: 4rem;
|
||||||
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Patterns navigation */
|
/* Patterns navigation */
|
||||||
|
|
Loading…
Reference in New Issue
Block a user