Skip to content

Commit 122bf1b

Browse files
committed
docs: Rebuild.
1 parent d4fab0c commit 122bf1b

File tree

3 files changed

+167
-126
lines changed

3 files changed

+167
-126
lines changed

docs/changelog.html

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,21 @@ <h2>Links</h2>
2828

2929
<h1 id="hindsite-change-log">Hindsite Change Log</h1>
3030
<p>See the <a href="https://github.com/srackham/hindsite/commits/master">Github commit logs</a> for a full list of changes.</p>
31-
<h2 id="version-1-3-0-2018-11-11">Version 1.3.0 (2018-11-11)</h2>
31+
<h2 id="version-1-4-0-2018-12-10">Version 1.4.0 (2018-12-10)</h2>
32+
<ul><li>Hindsite projects are now called <em>sites</em>. The word <em>site</em> is more descriptive
33+
and less generic than <em>project</em>.</li><li>Added the <a href="/hindsite/index.html#new-command"><code>new</code> command</a> which is used to create new
34+
content documents.</li><li>The hindsite <a href="/hindsite/index.html#commands"><em>site directory</em> command argument</a>
35+
(<code>SITE_DIR</code>) is optional and defaults to the current directory.</li><li>Added <a href="/hindsite/index.html#serve-command"><code>serve</code> command</a> <code>-navigate</code> option to
36+
automatically navigate to new and updated documents.</li><li>Extended <a href="/hindsite/index.html#serve-command"><code>serve</code> command</a> <code>-port
37+
[HTTP_PORT][:LR_PORT]</code> option to allow LiveReload port to be specified as well
38+
as LiveReload to be disabled.</li><li>Added <a href="/hindsite/index.html#serve-command"><code>serve</code> command</a> <code>D</code> and <code>N</code> interactive
39+
commands to toggle server <code>-drafts</code> and <code>-navigate</code> options respectively.</li></ul><h2 id="version-1-3-0-2018-11-11">Version 1.3.0 (2018-11-11)</h2>
3240
<ul><li>Allow unquoted date/time front matter <code>date</code> values in TOML headers.</li><li>Added site search to built-in <em>blog</em> template.</li><li>Additional tests (80.3% coverage).</li><li>Migrated to Go 1.11 modules.</li></ul><h2 id="version-1-2-0-2018-07-03">Version 1.2.0 (2018-07-03)</h2>
3341
<ul><li>The <code>serve</code> command now displays a sensible error message if the server port
3442
is already in use.</li><li><code>init</code> command behavioral change: If the <code>-template TEMPLATE_DIR</code> option
35-
specifies a location outside the project directory and the default
36-
<code>PROJECT_DIR/template</code> directory does not exist or is empty then the
37-
<code>TEMPLATE_DIR</code> is copied to <code>PROJECT_DIR/template</code>.</li><li>Implemented code coverage tests.</li></ul><h2 id="version-1-1-0-2018-06-23">Version 1.1.0 (2018-06-23)</h2>
43+
specifies a location outside the site directory and the default
44+
<code>SITE_DIR/template</code> directory does not exist or is empty then the
45+
<code>TEMPLATE_DIR</code> is copied to <code>SITE_DIR/template</code>.</li><li>Implemented code coverage tests.</li></ul><h2 id="version-1-1-0-2018-06-23">Version 1.1.0 (2018-06-23)</h2>
3846
<ul><li>Added document <code>id</code> front matter value along with the related <code>id</code>
3947
configuration parameter.</li><li>Colorized console error and success messages.</li><li>Better error messages.</li><li>Added <a href="/hindsite/faq.html#disqus-howto">Disqus FAQ</a>.</li><li>The <a href="/hindsite/index.html#build-command"><code>build</code> command</a> now reports parse errors from
4048
all documents instead of quitting at the first error.</li></ul><h2 id="version-1-0-0-2018-05-20">Version 1.0.0 (2018-05-20)</h2>

docs/faq.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h2>Links</h2>
2828

2929
<h1 id="hindsite-faq">Hindsite FAQ</h1>
3030
<h2 id="does-hindsite-support-themes">Does hindsite support themes?</h2>
31-
<p>Themes are baked in, every <a href="/hindsite/index.html#projects">project template directory</a>
31+
<p>Themes are baked in, every <a href="/hindsite/index.html#sites">site template directory</a>
3232
is a theme and the <a href="/hindsite/index.html#init-command">init command</a> is the &ldquo;theme&rdquo;
3333
installer.</p>
3434
<h2 id="why-does-the-serve-command-sometimes-fail-a-live-reload">Why does the <code>serve</code> command sometimes fail a live reload?</h2>
@@ -45,7 +45,7 @@ <h2 id="why-does-the-serve-command-sometimes-fail-a-live-reload">Why does the <c
4545
<h2 id="search-howto">How can I add site search to my website?</h2>
4646
<p>An easy way to add a site search feature is to use a <a href="https://cse.google.com">Google Custom Search Engine
4747
(CSE)</a>. For example, the hindsite built-in <a href="https://github.com/srackham/hindsite/tree/master/builtin/blog/template"><code>blog</code>
48-
project</a>
48+
site</a>
4949
includes a Google CSE search page. To customize it for your website you need to:</p>
5050
<ol><li>Create a <a href="https://cse.google.com">Google Custom Search Engine (CSE)</a> for your
5151
site.</li><li>Paste your site's CSE code into the
@@ -60,7 +60,7 @@ <h2 id="search-howto">How can I add site search to my website?</h2>
6060
Google</a>.</p>
6161
<h2 id="disqus-howto">How do I include Disqus comments in my website?</h2>
6262
<p>The recipe described below is taken from the hindsite <a href="https://github.com/srackham/hindsite/tree/master/builtin/blog/template">built-in <code>blog</code>
63-
project</a>.
63+
site</a>.
6464
If you <a href="/hindsite/index.html#init-command">initialized your site</a> with the built-in
6565
<code>blog</code> template then you already have the Disqus template and steps 3 and 4
6666
below are redundant.</p>
@@ -69,7 +69,7 @@ <h2 id="disqus-howto">How do I include Disqus comments in my website?</h2>
6969
your site's Disqus
7070
<a href="https://help.disqus.com/installation/whats-a-shortname"><code>shortname</code></a>, you
7171
need to include it along with some Disqus JavaScript code to your site's
72-
generated webpages.</li><li>Copy this <code>disqus</code> template definition to a project template file:<pre class="html"><code>{{define "disqus"}}
72+
generated webpages.</li><li>Copy this <code>disqus</code> template definition to a site template file:<pre class="html"><code>{{define "disqus"}}
7373
{{/*
7474
If the user `shortname` variable is set and the document `id` is
7575
non-blank then Disqus comments are inserted.
@@ -93,7 +93,7 @@ <h2 id="disqus-howto">How do I include Disqus comments in my website?</h2>
9393
{{end}}</code></pre>
9494
</li><li>Include the Disqus template in your web pages by adding this line to the end
9595
of the HTML body in your document footer template:<pre><code>{{template "disqus" .}}</code></pre>
96-
</li><li>Add a <code>user</code> <code>shortname</code> entry to the project <a href="/hindsite/index.html#configuration"><code>config</code>
96+
</li><li>Add a <code>user</code> <code>shortname</code> entry to the site <a href="/hindsite/index.html#configuration"><code>config</code>
9797
file</a> and set it to your site's Disqus
9898
<a href="https://help.disqus.com/installation/whats-a-shortname"><code>shortname</code></a>. TOML
9999
example:<pre><code>[user]
@@ -186,10 +186,10 @@ <h2 id="how-fast-is-hindsite">How fast is hindsite?</h2>
186186
<h4 id="hindsite-v1-0-0-windows-amd64-running-on-dell-xps27-pc-under-windows-10">hindsite v1.0.0 (windows/amd64) running on Dell XPS27 PC under Windows 10.</h4>
187187
<dl><dt><em>Execution times</em></dt><dd><ul><li><code>hindsite build</code> command: 27.72s (full build, average of 5).</li><li><code>hindsite serve</code> command: 29.64s (full rebuild, average of 5).</li><li><code>hindsite serve</code> command: 4.91s (partial build, one document and
188188
entire index, average of 5).</li><li><code>hindsite serve</code> command: 0.07s (partial build, one document and related index
189-
pages, average of 5).</li></ul></dd><dt><em>Memory consumption</em></dt><dd><ul><li><code>hindsite build</code> command: 34MB</li><li><code>hindsite server</code> command: 62MB</li></ul></dd></dl><h4 id="hugo-v0-40-3-windows-amd64-running-on-dell-xps27-pc-under-windows-10">Hugo v0.40.3 (windows/amd64) running on Dell XPS27 PC under Windows 10</h4>
189+
pages, average of 5).</li></ul></dd><dt><em>Memory consumption</em></dt><dd><ul><li><code>hindsite build</code> command: 34MB</li><li><code>hindsite serve</code> command: 62MB</li></ul></dd></dl><h4 id="hugo-v0-40-3-windows-amd64-running-on-dell-xps27-pc-under-windows-10">Hugo v0.40.3 (windows/amd64) running on Dell XPS27 PC under Windows 10</h4>
190190
<p>Hugo setup as per the <a href="https://gohugo.io/getting-started/quick-start/">Hugo <em>Quick Start</em>
191191
instructions</a>.</p>
192-
<dl><dt><em>Execution times</em></dt><dd><ul><li><code>hugo</code> command: 162.92s (full build, average of 5).</li><li><code>hugo server</code> command: 128.64s (initial full build).</li><li><code>hugo server</code> command: 0.47s (partial rebuild).</li></ul></dd><dt><em>Memory consumption</em></dt><dd><ul><li><code>hugo</code> command: 337MB</li><li><code>hugo server</code> command: 11.2GB</li></ul></dd></dl><p><i class="sans-font">NOTE</i>: Exclude the project folders from Windows Defender anti-virus real-time
192+
<dl><dt><em>Execution times</em></dt><dd><ul><li><code>hugo</code> command: 162.92s (full build, average of 5).</li><li><code>hugo server</code> command: 128.64s (initial full build).</li><li><code>hugo server</code> command: 0.47s (partial rebuild).</li></ul></dd><dt><em>Memory consumption</em></dt><dd><ul><li><code>hugo</code> command: 337MB</li><li><code>hugo server</code> command: 11.2GB</li></ul></dd></dl><p><i class="sans-font">NOTE</i>: Exclude the site folders from Windows Defender anti-virus real-time
193193
protection (not doing this imposed a 4x performance decrease for both hindsite
194194
and Hugo).</p>
195195
<p>The benchmarked hindsite and Hugo projects are available in the downloadable
@@ -208,10 +208,10 @@ <h4 id="hindsite-v1-0-0-windows-amd64-running-on-dell-xps27-pc-under-windows-10"
208208
├── static
209209
└── themes</code></pre>
210210
<p>To compare performance run <code>hindsite</code> and <code>hugo</code> commands from their respective
211-
project directories:</p>
211+
site directories:</p>
212212
<pre><code>cd hindsite
213-
hindsite build . # Build.
214-
hindsite serve . # Build and serve.
213+
hindsite build # Build.
214+
hindsite serve # Build and serve.
215215

216216
cd hugo
217217
hugo # Build.
@@ -229,8 +229,8 @@ <h2 id="why-did-you-create-hindsite">Why did you create hindsite?</h2>
229229
theme tweak) motivated me to write hindsite.</p>
230230
<p>Hindsite was designed to be easy to learn and use, it was not designed to
231231
compete with hugo's massive feature set.</p>
232-
<p>The casual use-case argument is the same reason my go-to drawing program is
233-
Microsoft Paint or KolorPaint and not Adobe Photoshop or The Gimp.</p>
232+
<p>The casual use argument is the same reason my go-to drawing program is Microsoft
233+
Paint or KolorPaint and not Adobe Photoshop or The Gimp.</p>
234234

235235

236236
</div>

0 commit comments

Comments
 (0)