Skip to content

Commit 7364d63

Browse files
committed
docs: Rebuild.
1 parent c684f65 commit 7364d63

File tree

3 files changed

+88
-65
lines changed

3 files changed

+88
-65
lines changed

docs/changelog.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ <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-1-0-2018-06-todo">Version 1.1.0 (2018-06-<b style="color: red; background-color: yellow;">TODO</b>)</h2>
31+
<h2 id="version-1-1-0-2018-06-23">Version 1.1.0 (2018-06-23)</h2>
3232
<ul><li>Added document <code>id</code> front matter value along with the related <code>id</code>
33-
configuration parameter.</li><li>Colorized console error and success messages.</li><li>Updated documentation: added change log and <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
33+
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
3434
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>
3535
<p>First public release.</p>
3636

docs/faq.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ <h2 id="does-hindsite-support-themes">Does hindsite support themes?</h2>
3131
<p>Themes are baked in, every <a href="/hindsite/index.html#projects">project 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>
34+
<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>
35+
<p>Some text editors create temporary and backup files when documents are saved and
36+
created, you need to exclude these files from document processing. Failure to do
37+
so can result in rebuild false positives and premature watcher reloads.</p>
38+
<p>For example, the Vim editor creates tilda prefixed backup files and temporary
39+
<a href="https://github.com/neovim/neovim/issues/3460"><code>4913</code> files</a> so you need to add
40+
them to the <a href="/hindsite/index.html#configuration-parameters"><code>exclude</code></a> configuration
41+
parameter in the templates directory root <a href="/hindsite/index.html#configuration-files">configuration
42+
file</a>.</p>
43+
<p>TOML example:</p>
44+
<pre><code>exclude = "*~|4913"</code></pre>
3445
<h2 id="disqus-howto">How do I include Disqus comments in my website?</h2>
3546
<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>
3647
project</a>.
@@ -67,7 +78,11 @@ <h2 id="disqus-howto">How do I include Disqus comments in my website?</h2>
6778
</li><li>Include the Disqus template in your web pages by adding this line to the end
6879
of the HTML body in your document footer template:<pre><code>{{template "disqus" .}}</code></pre>
6980
</li><li>Add a <code>user</code> <code>shortname</code> entry to the project <a href="/hindsite/index.html#configuration"><code>config</code>
70-
file</a>.</li></ol><p>That's it, all published documents with a non-blank <a href="/hindsite/index.html#document-id">document
81+
file</a> and set it to your site's Disqus
82+
<a href="https://help.disqus.com/installation/whats-a-shortname"><code>shortname</code></a>. TOML
83+
example:<pre><code>[user]
84+
shortname = "disqus-shortname-goes-here"</code></pre>
85+
</li></ol><p>That's it, all published documents with a non-blank <a href="/hindsite/index.html#document-id">document
7186
<code>id</code></a> will now include Disqus comments.</p>
7287
<ul><li>You can automatically assign document <code>id</code>s to all documents by setting the
7388
<a href="/hindsite/index.html#id-configuration-parameter"><code>id</code> configuration parameter</a> to

0 commit comments

Comments
 (0)