You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<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 <ahref="/hindsite/index.html#new-command"><code>new</code> command</a> which is used to create new
(<code>SITE_DIR</code>) is optional and defaults to the current directory.</li><li>Added <ahref="/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 <ahref="/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 <ahref="/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><h2id="version-1-3-0-2018-11-11">Version 1.3.0 (2018-11-11)</h2>
32
40
<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><h2id="version-1-2-0-2018-07-03">Version 1.2.0 (2018-07-03)</h2>
33
41
<ul><li>The <code>serve</code> command now displays a sensible error message if the server port
34
42
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><h2id="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><h2id="version-1-1-0-2018-06-23">Version 1.1.0 (2018-06-23)</h2>
38
46
<ul><li>Added document <code>id</code> front matter value along with the related <code>id</code>
39
47
configuration parameter.</li><li>Colorized console error and success messages.</li><li>Better error messages.</li><li>Added <ahref="/hindsite/faq.html#disqus-howto">Disqus FAQ</a>.</li><li>The <ahref="/hindsite/index.html#build-command"><code>build</code> command</a> now reports parse errors from
40
48
all documents instead of quitting at the first error.</li></ul><h2id="version-1-0-0-2018-05-20">Version 1.0.0 (2018-05-20)</h2>
Copy file name to clipboardExpand all lines: docs/faq.html
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ <h2>Links</h2>
28
28
29
29
<h1id="hindsite-faq">Hindsite FAQ</h1>
30
30
<h2id="does-hindsite-support-themes">Does hindsite support themes?</h2>
31
-
<p>Themes are baked in, every <ahref="/hindsite/index.html#projects">project template directory</a>
31
+
<p>Themes are baked in, every <ahref="/hindsite/index.html#sites">site template directory</a>
32
32
is a theme and the <ahref="/hindsite/index.html#init-command">init command</a> is the “theme”
33
33
installer.</p>
34
34
<h2id="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
45
45
<h2id="search-howto">How can I add site search to my website?</h2>
46
46
<p>An easy way to add a site search feature is to use a <ahref="https://cse.google.com">Google Custom Search Engine
47
47
(CSE)</a>. For example, the hindsite built-in <ahref="https://github.com/srackham/hindsite/tree/master/builtin/blog/template"><code>blog</code>
48
-
project</a>
48
+
site</a>
49
49
includes a Google CSE search page. To customize it for your website you need to:</p>
50
50
<ol><li>Create a <ahref="https://cse.google.com">Google Custom Search Engine (CSE)</a> for your
51
51
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>
60
60
Google</a>.</p>
61
61
<h2id="disqus-howto">How do I include Disqus comments in my website?</h2>
62
62
<p>The recipe described below is taken from the hindsite <ahref="https://github.com/srackham/hindsite/tree/master/builtin/blog/template">built-in <code>blog</code>
63
-
project</a>.
63
+
site</a>.
64
64
If you <ahref="/hindsite/index.html#init-command">initialized your site</a> with the built-in
65
65
<code>blog</code> template then you already have the Disqus template and steps 3 and 4
66
66
below are redundant.</p>
@@ -69,7 +69,7 @@ <h2 id="disqus-howto">How do I include Disqus comments in my website?</h2>
69
69
your site's Disqus
70
70
<ahref="https://help.disqus.com/installation/whats-a-shortname"><code>shortname</code></a>, you
71
71
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:<preclass="html"><code>{{define "disqus"}}
72
+
generated webpages.</li><li>Copy this <code>disqus</code> template definition to a site template file:<preclass="html"><code>{{define "disqus"}}
73
73
{{/*
74
74
If the user `shortname` variable is set and the document `id` is
75
75
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>
93
93
{{end}}</code></pre>
94
94
</li><li>Include the Disqus template in your web pages by adding this line to the end
95
95
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<ahref="/hindsite/index.html#configuration"><code>config</code>
96
+
</li><li>Add a <code>user</code><code>shortname</code> entry to the site<ahref="/hindsite/index.html#configuration"><code>config</code>
@@ -186,10 +186,10 @@ <h2 id="how-fast-is-hindsite">How fast is hindsite?</h2>
186
186
<h4id="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>
187
187
<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
188
188
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><h4id="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><h4id="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>
190
190
<p>Hugo setup as per the <ahref="https://gohugo.io/getting-started/quick-start/">Hugo <em>Quick Start</em>
191
191
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><iclass="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><iclass="sans-font">NOTE</i>: Exclude the site folders from Windows Defender anti-virus real-time
193
193
protection (not doing this imposed a 4x performance decrease for both hindsite
194
194
and Hugo).</p>
195
195
<p>The benchmarked hindsite and Hugo projects are available in the downloadable
0 commit comments