Skip to content
Permalink
Browse files

Reorganized help section

  • Loading branch information...
davidmerfield committed Mar 14, 2019
1 parent 7c4c133 commit 4bd7a6cb33626b995df1226c533e19ed0cec4a3d
@@ -25,8 +25,8 @@
Pages
Posts
Apple.md
Bannana.txt
Cherry.txt
Bannana.jpg
Cherry.docx


</code></pre></a>
@@ -33,40 +33,35 @@
<li class="{{selected.drafts}}">
<a href="{{{base}}}/publishing/drafts">Drafts</a>
</li>
<li class="{{selected.tags}}">
<a href="{{{base}}}/publishing/tags">Tags</a>
</li>
<li class="{{selected.dates}}">
<a href="{{{base}}}/publishing/dates">Dates</a>
</li>
<li class="{{selected.public-files}}">
<a href="{{{base}}}/publishing/public-files">Public files</a>
</li>
<li class="{{selected.metadata}}">
<a href="{{{base}}}/publishing/metadata">Metadata</a>
</li>
<li>
<a href="/publishing/formatting">Formatting guide</a>
</li>
<li class="{{selected.configuring}}">
<a href="{{{base}}}/publishing/configuring">Configuring your blog</a>
</li>
<li class="{{selected.redirects}}">
<a href="{{{base}}}/publishing/clients">Clients</a>
</li>
<li class="{{selected.domain}}">
<a href="{{{base}}}/publishing/domain">Use your own domain</a>
</li>
<li class="{{selected.redirects}}">
<!-- <li class="{{selected.redirects}}">
<a href="{{{base}}}/publishing/redirects">Redirects</a>
</li>
<li class="{{selected.urls}}">
<a href="{{{base}}}/publishing/urls">URLs</a>
</li>
<li>
<a href="/publishing/formatting">Formatting guide</a>
</li>
-->



<li class="{{selected.services}}">
<a href="{{{base}}}/publishing/services">External services</a>
<li class="{{selected.redirects}}">
<a href="{{{base}}}/publishing/clients">Clients</a>
</li>

<br>
</ul>
</li>
@@ -177,7 +177,7 @@
<h1>News</h1>
<p>The lists below give you an idea of what I'm working on. I send out an email each season with a summary of new features, templates, fixed bugs and future plans. <!-- View the <a href="/news/archive">newsletter archive</a>. --> Please don't hesitate to <a href="/contact">contact me</a> if you have any questions.</p>

<p>
<br><p>
<form action="/news/sign-up" method="POST" style="max-width:35em;">
<label for="email">Your email</label>
<div style="display:flex">
@@ -3,7 +3,7 @@ <h1>Configuring your blog</h1>
<p>All of your blog’s configuration is done on <a href="/log-in">the dashboard</a>. Use the dashboard to select a template, adjust Blot’s settings and set up your blog on your own domain. </p>

<h2>Use your own domain</h2>
<p>Every blog comes with a subdomain that you are free to use. You can also set up your blog on your own domain. <a href="/configuring/domain" class="measure next small db bt b--black-10">
<p>Every blog comes with a subdomain that you are free to use. You can also set up your blog on your own domain. <a href="/publishing/domain" class="measure next small db bt b--black-10">
Guide to using your own domain
</a></p>

@@ -12,13 +12,13 @@ <h2>Importing posts</h2>
<p>I’ve written scripts to generate a folder of files from sites built on <a href="https://github.com/davidmerfield/Blot/tree/master/app/dashboard/routes/importer/sources/tumblr">Tumblr</a>, <a href="https://github.com/davidmerfield/Blot/tree/master/app/dashboard/routes/importer/sources/wordpress">Wordpress</a>, <a href="https://github.com/davidmerfield/Blot/tree/master/app/dashboard/routes/importer/sources/jekyll">Jekyll</a> and <a href="https://github.com/davidmerfield/Blot/tree/master/app/dashboard/routes/importer/sources/squarespace">Squarespace</a>. You can run them yourself or <a href="/contact">contact me</a> and I will run them for you.</p>

<h2>Redirects</h2>
<p>You can set up redirects to prevent broken links on your blog. Your blog’s 404 log will help you discover URLs which need redirects.<a href="/configuring/redirects" class="measure next small db bt b--black-10">
<p>You can set up redirects to prevent broken links on your blog. Your blog’s 404 log will help you discover URLs which need redirects.<a href="/publishing/configuring/redirects" class="measure next small db bt b--black-10">
Guide to setting up redirects
</a>
</p>

<h2>Permalinks</h2>
<p>You can change the format of the permalinks generated automatically for each blog post. <a href="/configuring/urls" class="measure next small db bt b--black-10">
<p>You can change the format of the permalinks generated automatically for each blog post. <a href="/publishing/configuring/urls" class="measure next small db bt b--black-10">
Guide to changing your blog’s permalinks
</a></p>

@@ -31,3 +31,27 @@ <h2>Importing posts</h2>
<h2>Typography</h2>
<p>Blot comes with a number of features to refine the typography of your blog. This includes true hanging punctuation and common typographic substitutions with <a href="https://github.com/davidmerfield/typeset">Typeset</a>. Blot also renders mathematics in <a class="bn" href="/publishing/formatting">\(\TeX\)</a>and provides syntax highlighting for code.</p>

<h2>Analytics</h2>
<p>Blot makes it easy to set up Google Analytics, Heap and Clicky.</p>

<h2>Comments</h2>
<p>Blot makes it easy to set up Disqus.</p>

<h2>Videos</h2>
<p>Blot converts URLs to YouTube and Vimeo into videos. You can embed a YouTube video like this:</p>

<p><code>https://www.youtube.com/watch?v=cmaNByqIeeQ</code></p>

<p>You can paste the HTML for a video player directly into the post if you prefer.</p>


<h2>Typography</h2>

<p>Blot comes with a number of features to refine the typography of your blog. This includes true hanging punctuation and common typographic substitutions with <a href="https://github.com/davidmerfield/typeset">Typeset</a>. Blot also renders mathematics in <a class="bn" href="/publishing/formatting">\(\TeX\)</a>and provides syntax highlighting for code.</p>
<ul>
<li>Real hang­ing punc­tu­a­tion</li>
<li>Soft hy­phen in­ser­tion</li>
<li>Optical mar­gin align­ment</li>
<li>Small caps de­tec­tion</li>
<li>Punctuation sub­sti­tu­tion</li>
</ul>

This file was deleted.

Oops, something went wrong.
@@ -1,7 +1,18 @@
<h1>Formatting guide</h1>

<p style="margin-top:0">You can use a variety of standard tools to add formatting to your blog posts. Text files can include <a href="/publishing/formatting/markdown">Markdown</a> to add links, headings, lists and much more. You can mark up mathematics in <a style="border:none;text-decoration:none;margin-right:-4px" href="/publishing/formatting/tex">\(\TeX\)</a>. Note that Blot can turn <a href="/publishing">HTML files</a> into blog posts.</p>
<p>You can use a variety of standard tools to add formatting to your blog posts.</b> <a href="/publishing/formatting/markdown">Markdown</a> to add links, headings, lists and much more. Blot also renders mathematics set in <a class="bn" href="/publishing/formatting/tex">\(\TeX\)</a> and</span> provides syntax highlighting for code snippets.</p>

<!-- <background><pre class="text with-chrome narrow" title="Post"><code><b># Formatting</b>
You can use <em>*Markdown*</em>, a lightweight markup language for plain text files.
Use it for links, headings, lists and much more.
</code>
</pre>
</background> -->

<h2>Guides</h2>

<ul class="clients">
<li><a href="/publishing/formatting/markdown"><strong>Markdown</strong><br> A lightweight markup language with plain text formatting syntax.</a> </li>
@@ -11,6 +11,99 @@ <h1>Metadata</h1>
</code></pre>
</div>

<h2>Dates</h2>

<p>A blog post’s publish date is the same as the file’s creation date by default. You can specify a different date in the file’s <a href="#path">path</a> or in its <a href="{{{base}}}/publishing/metadata">metadata</a>:</p>
<div style="max-width:39em;margin:3em 0 4em">
<pre class="text with-chrome" title="Post.txt"><code>Date: {{#date}}MMMM Do, YYYY{{/date}}

Blot supports a variety of date formats. These all produce a post with the same date:

{{#date}}MM/DD/YYYY{{/date}} {{#date}}MMMM D, YYYY{{/date}}
{{#date}}M.D.YYYY{{/date}} {{#date}}YYYY-MM-DD 00-00{{/date}}

You can use underscores, dashes, slashes and dots to seperate the numbers in the date.
</code></pre>
</div>
<p>You can specify a post’s publish date in its path. For example, all four of these posts share the same publish date:</p>
<table>
<tbody>
<tr>
<td>
<code class="folder">&nbsp;{{#date}}YYYY{{/date}}<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="folder">&nbsp;{{#date}}MM{{/date}}<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="folder">&nbsp;{{#date}}DD{{/date}}<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="file md">&nbsp;Post.txt</a></code>
</td>
</tr>
<tr>
<td>
<code class="folder">&nbsp;{{#date}}YYYY{{/date}}<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="folder">&nbsp;{{#date}}MM{{/date}}<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="file md">&nbsp;{{#date}}DD-[Post.txt]{{/date}}</code>
</td>
</tr>
<tr>
<td>
<code class="folder">&nbsp;{{#date}}YYYY{{/date}}<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="file md">&nbsp;{{#date}}MM-DD-[Post.txt]{{/date}}</code>
</td>
</tr>
<tr>
<td><code class="file md">&nbsp;{{#date}}YYYY-MM-DD-00-00[-Post.txt]{{/date}}</a></code></td>
</tr>

</tbody>
</table>
<p>Please note that a date specified in the file’s <a href="{{{base}}}/publishing/metadata">metadata</a> takes precedence. If you specify a date in the future, your post will be published then.</p>

</div>

<h2>Tags</h2>

<p>Use tags to connect posts by similar subject. Specify tags in the file’s <a href="{{{base}}}/publishing/metadata">metadata</a> or in its <a href="#path">path</a>. Here’s an example blog post with two tags in its metadata:</p>

<background><pre class="text with-chrome" title="Post.txt"><code>Tags: Getting started, Documentation

Tags are case-insensitive and may contain whitespace. Blot picks the case you used last when displaying the tag on your blog.



</code></pre>
</background>

<p>You can add tags to a post in the file’s name or path. Include the tag, wrapped in brackets. Here’s a few examples:</p>

<table style=" table-layout: auto;">
<tbody>
<tr>
<td>
<code class="folder">&nbsp;[Photos]<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="folder">&nbsp;[Holiday]<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="file img">&nbsp;Picture.jpg</a></code>
</td>
<td class="light">...&puncsp;is tagged&puncsp;...</td>
<td>Photos, Holiday</td>
</tr>
<tr>
<td>
<code class="folder">&nbsp;[Book notes]<span class="light">&nbsp;/&nbsp;</span></code>&nbsp;
<code class="file md">&nbsp;Thief.txt</a></code>
</td>
<td class="light">...&puncsp;is tagged&puncsp;...</td>
<td>Book notes</td>
</tr>
<tr>
<td>
<code class="file md">&nbsp;[Reviews] Pnin.txt</a></code>
</td>
<td class="light">...&puncsp;is tagged&puncsp;...</td>
<td>Reviews</td>
</tr>

</tbody>
</table>

<h2>Metadata reference</h2>
<table style="max-width:39em;table-layout:auto">
<tbody>

This file was deleted.

Oops, something went wrong.

This file was deleted.

Oops, something went wrong.

0 comments on commit 4bd7a6c

Please sign in to comment.
You can’t perform that action at this time.