docs folder

This commit is contained in:
Heydon Pickering 2017-07-03 18:10:00 +01:00
parent 1ebaaf1290
commit e335e1d308
40 changed files with 6 additions and 9 deletions

View File

@ -3,6 +3,7 @@ title = "Infusion"
baseURL = "https://heydon.github.io/infusion/" baseURL = "https://heydon.github.io/infusion/"
canonifyURLs = true canonifyURLs = true
theme = "infusion" theme = "infusion"
publishDir = "docs"
[params] [params]
description = "Documentation for the <strong>Infusion</strong> pattern library builder. This documentation is constructed using the builder itself." description = "Documentation for the <strong>Infusion</strong> pattern library builder. This documentation is constructed using the builder itself."

View File

@ -8,7 +8,7 @@ While you're creating content for your library, you'll probably want to see what
{{<cmd>}}npm run serve{{</cmd>}} {{<cmd>}}npm run serve{{</cmd>}}
This will serve your working library on `localhost:1313`. Whenever you make changes to your library's files, the site will automatically rebuild. No need to refresh the web page! This will serve your working library from `localhost:1313` (the exact URL will be determined by what's in your `baseURL` and will be revealed to you by your terminal). Whenever you make changes to your library's files, the site will automatically rebuild. No need to refresh the web page!
## Publishing on Github Pages ## Publishing on Github Pages

View File

Before

Width:  |  Height:  |  Size: 535 B

After

Width:  |  Height:  |  Size: 535 B

View File

Before

Width:  |  Height:  |  Size: 415 B

After

Width:  |  Height:  |  Size: 415 B

View File

Before

Width:  |  Height:  |  Size: 1002 B

After

Width:  |  Height:  |  Size: 1002 B

View File

Before

Width:  |  Height:  |  Size: 658 B

After

Width:  |  Height:  |  Size: 658 B

View File

Before

Width:  |  Height:  |  Size: 790 B

After

Width:  |  Height:  |  Size: 790 B

View File

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 9.0 KiB

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

@ -134,8 +134,7 @@ I can reference the &amp;#x7b;{% pattern &#34;Notes &amp; warnings&#34; %}} patt
<guid>https://heydon.github.io/infusion/patterns/serving/</guid> <guid>https://heydon.github.io/infusion/patterns/serving/</guid>
<description>Serving locally While you&amp;rsquo;re creating content for your library, you&amp;rsquo;ll probably want to see what the finished product looks like. Fortunately, Infusion is easy to serve locally using the serve command: <description>Serving locally While you&amp;rsquo;re creating content for your library, you&amp;rsquo;ll probably want to see what the finished product looks like. Fortunately, Infusion is easy to serve locally using the serve command:
npm run serve This will serve your working library on localhost:1313. Whenever you make changes to your library&amp;rsquo;s files, the site will automatically rebuild. No need to refresh the web page! npm run serve This will serve your working library from localhost:1313 (the exact URL will be determined by what&amp;rsquo;s in your baseURL and will be revealed to you by your terminal). Whenever you make changes to your library&amp;rsquo;s files, the site will automatically rebuild.</description>
Publishing on Github Pages There are three steps to hosting your library on Github Pages.</description>
</item> </item>
<item> <item>

View File

@ -39,8 +39,7 @@ brew install hugo Alternatively, you can manually install Hugo from a package. Y
<guid>https://heydon.github.io/infusion/patterns/serving/</guid> <guid>https://heydon.github.io/infusion/patterns/serving/</guid>
<description>Serving locally While you&amp;rsquo;re creating content for your library, you&amp;rsquo;ll probably want to see what the finished product looks like. Fortunately, Infusion is easy to serve locally using the serve command: <description>Serving locally While you&amp;rsquo;re creating content for your library, you&amp;rsquo;ll probably want to see what the finished product looks like. Fortunately, Infusion is easy to serve locally using the serve command:
npm run serve This will serve your working library on localhost:1313. Whenever you make changes to your library&amp;rsquo;s files, the site will automatically rebuild. No need to refresh the web page! npm run serve This will serve your working library from localhost:1313 (the exact URL will be determined by what&amp;rsquo;s in your baseURL and will be revealed to you by your terminal). Whenever you make changes to your library&amp;rsquo;s files, the site will automatically rebuild.</description>
Publishing on Github Pages There are three steps to hosting your library on Github Pages.</description>
</item> </item>
</channel> </channel>

View File

@ -194,7 +194,7 @@
<pre class="cmd"><code>npm run serve</code></pre> <pre class="cmd"><code>npm run serve</code></pre>
<p>This will serve your working library on <code>localhost:1313</code>. Whenever you make changes to your library&rsquo;s files, the site will automatically rebuild. No need to refresh the web page!</p> <p>This will serve your working library from <code>localhost:1313</code> (the exact URL will be determined by what&rsquo;s in your <code>baseURL</code> and will be revealed to you by your terminal). Whenever you make changes to your library&rsquo;s files, the site will automatically rebuild. No need to refresh the web page!</p>
<h2 id="publishing-on-github-pages">Publishing on Github Pages</h2> <h2 id="publishing-on-github-pages">Publishing on Github Pages</h2>

View File

@ -8,9 +8,7 @@
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"serve": "hugo server", "serve": "hugo server",
"clean": "rm -rf content && mkdir content && mkdir content/patterns && hugo new patterns/pattern.md && hugo new _index.md", "clean": "rm -rf content && mkdir content && mkdir content/patterns && hugo new patterns/pattern.md && hugo new _index.md",
"build": "hugo", "build": "hugo"
"setup": "hugo && git add public",
"host": "hugo && git push origin `git subtree split --prefix public master`:gh-pages --force"
}, },
"repository": { "repository": {
"type": "git", "type": "git",