hugopoi/cupper-hugo-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated hosting advice

Browse Source
This commit is contained in:
Heydon Pickering 2017-06-29 09:19:24 +01:00
parent 635bd1da69
commit 50c662077b
2 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
content/patterns/serving.md
View File

@ -12,12 +12,12 @@ 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. 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.
{{<cmd>}}git commit -am "my commit message"{{</cmd>}}
This will ensure changes go through to `gh-pages`. Now you can run:
{{<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 `github.io/[your username]/[your library repo name]`.
{{% warning %}}
The `host` command *force* pushes the contents of the `public` folder to `gh-pages`. This is not in itself problematic since nothing is overwritten on the `master` branch. However, be aware that the command does not push your `master` branch changes to origin. You still have to commit and push any changes you've made locally.
{{% /warning %}}

18
public/patterns/serving/index.html
View File

@ -192,21 +192,17 @@
<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&rsquo;s <code>gh-pages</code> 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&rsquo;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>
<pre class="cmd"><code>git commit -am "my commit message"</code></pre>
<p>This will ensure changes go through to <code>gh-pages</code>. Now you can run:</p>
<pre class="cmd"><code>npm run host</code></pre> <pre class="cmd"><code>npm run host</code></pre>
<p>You should now be able to find a &ldquo;live&rdquo; version of your library at <code>github.io/[your username]/[your library repo' name]</code>.</p> <p>You should now be able to find a &ldquo;live&rdquo; version of your library at <code>github.io/[your username]/[your library repo name]</code>.</p>
<aside aria-label="warning" class="note warning">
<div>
<img src="https://heydon.github.io/infusion/images/icon-warning.svg" alt="">
<p>The <code>host</code> command <em>force</em> pushes the contents of the <code>public</code> folder to <code>gh-pages</code>. This is not in itself problematic since nothing is overwritten on the <code>master</code> branch. However, be aware that the command does not push your <code>master</code> branch changes to origin. You still have to commit and push any changes you&rsquo;ve made locally.</p>
</div>
</aside>
</main> </main>