Merge pull request #131 from davidmerfield/brochure-reorganization

Re-organized links on documentation

app/brochure/routes/index.js

@@ -54,8 +54,6 @@ brochure.get("/sitemap.xml", require("./sitemap"));
 
 brochure.use("/developers", require("./developers"));
 
-brochure.use("/formatting", require("./formatting"));
-
 // brochure.use("/templates", require("./templates"));
 
 brochure.use("/news", require("./news"));
@@ -92,6 +90,10 @@ brochure.get("/", function(req, res) {
   res.render("index");
 });
 
+var tex = require('./tools/tex');
+
+brochure.use('/publishing/formatting', tex);
+
 brochure.get("/:section", function(req, res, next) {
   // This check is designed to prevent an error polluting
   // the logs which happens for requests like /images/foo.png
@@ -120,6 +122,22 @@ brochure.get("/:section/:subsection", function(req, res, next) {
   res.render(req.params.section + "/" + req.params.subsection);
 });
 
+brochure.get("/:section/:subsection/:subsubsection", function(req, res, next) {
+  // This check is designed to prevent an error polluting
+  // the logs which happens for requests like /images/foo.png
+  // Express doesn't have a renderer for '.png' so there is an error
+  if (
+    req.params.section.indexOf(".") > -1 ||
+    req.params.subsection.indexOf(".") > -1
+  ) {
+    return next();
+  }
+
+  res.locals.title =
+    "Blot – " + req.params.subsubsection + " – " + req.params.section;
+  res.render(req.params.section + "/" + req.params.subsection + '/' + req.params.subsubsection);
+});
+
 brochure.use(function(err, req, res, next) {
   if (config.environment === "development") console.log(err);
   next();

app/brochure/views/account-billing.html

@@ -4,12 +4,12 @@ <h1>Account and billing</h1>
 
 <h2>Multiple blogs</h2>
 
-<p>You can manage multiple blogs from the same account. Each blog is independent: you could use <a href="/clients/dropbox">Dropbox</a> with one and <a href="/clients/git">Git</a> with another. Your blogs can use the same Dropbox account, or different accounts. Each blog costs <a href="/sign-up">{{price}} per year</a>.</p>
+<p>You can manage multiple blogs from the same account. Each blog is independent: you could use <a href="/publishing/clients/dropbox">Dropbox</a> with one and <a href="/publishing/clients/git">Git</a> with another. Your blogs can use the same Dropbox account, or different accounts. Each blog costs <a href="/sign-up">{{price}} per year</a>.</p>
 
 <h2>Alternatives to Dropbox and Git</h2>
 
 <p>
-  I plan to add support for <a href="https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol">SFTP</a>, and finally other services like <a href="https://www.google.com/drive/">Google Drive</a>. At the moment, you can <a href="/clients">sync your blog’s folder</a> using Git or Dropbox. </p>
+  I plan to add support for <a href="https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol">SFTP</a>, and finally other services like <a href="https://www.google.com/drive/">Google Drive</a>. At the moment, you can <a href="/publishing/clients">sync your blog’s folder</a> using Git or Dropbox. </p>
 
 <h2>Subscription renewals</h2>
 <p>
@@ -23,6 +23,10 @@ <h2>Bandwidth and storage limits</h2>
   Dropbox’s <a href="https://www.dropbox.com/help/security/banned-links#traffic">traffic limits</a> do not apply because Blot hosts the contents of your folder on its own server.
 </p>
 
+
+<h2>Language support</h2>
+<p>Blot’s dashboard, <a href="/publishing">documentation</a>, <a href="/contact">support</a> and <a href="#templates">templates</a> are available in English.</p>
+
 <h2>Canceling your subscription</h2>
 <p>
   You can cancel your subscription on the <a href="/account">account page</a>. You can choose to <a href="/account/delete">delete your account</a> immediately, or wait until the end of your billing period.</p>

app/brochure/views/contact.html

@@ -1,3 +1,3 @@
 <h1>Contact</h1>
 
-<p>You can email <a href="mailto:support@blot.im">support@blot.im</a> directly. Feel free to send a message through <a href="https://twitter.com/blot__">Twitter</a> for short or less urgent inquiries. I’m <a href="https://twitter.com/David_Merfield">David</a>, by the way.</p>
+<p>You can email <a href="mailto:support@blot.im">support@blot.im</a> directly. Feel free to send a message through <a href="https://twitter.com/blot__">Twitter</a> for short or less urgent inquiries.<!--  I’m <a href="https://twitter.com/David_Merfield">David</a>, by the way. --></p>

app/brochure/views/layout.html

@@ -45,6 +45,28 @@
         <li class="{{selected.metadata}}">
           <a href="{{{base}}}/publishing/metadata">Metadata</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}}">
+          <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>
         <br>
       </ul>
       </li>
@@ -92,68 +114,24 @@
       </ul>
       </li>
 
-      <li class="has-list {{selected.configuring}}">
-        <input type="checkbox" name="configuring" id="configuring" {{#selected.configuring}} checked{{/selected.configuring}}> <a href="{{{base}}}/configuring">Configuring
-        <!--  your blog --><label for="configuring"></label></a>
-        <ul>
-          <li class="{{selected.domain}}">
-            <a href="{{{base}}}/configuring/domain">Use your own domain</a>
-          </li>
-          <li class="{{selected.import}}">
-            <a href="{{{base}}}/configuring/import">Importing posts</a>
-          </li>
-          <li class="{{selected.redirects}}">
-            <a href="{{{base}}}/configuring/redirects">Redirects</a>
-          </li>
-          <li class="{{selected.urls}}">
-            <a href="{{{base}}}/configuring/urls">URLs</a>
-          </li>
-          <li class="{{selected.services}}">
-            <a href="{{{base}}}/configuring/services">External services</a>
-          </li>
-          <br>
-        </ul>
-      </li>
-
-      <li class="has-list {{selected.clients}}">
-        <input type="checkbox" name="clients" id="clients" {{#selected.clients}} checked{{/selected.clients}}> <a href="{{{base}}}/clients">Clients<label for="clients"></label></a>
-        <ul>
-          <li class="{{selected.dropbox}}">
-            <a href="{{{base}}}/clients/dropbox">Dropbox</a>
-          </li>
-          <li class="{{selected.git}}">
-            <a href="{{{base}}}/clients/git">Git</a>
-          </li>
-          <br>
-        </ul>
-      </li>
-
       <li class="{{selected.account-billing}}">
         <a href="{{{base}}}/account-billing">Account and billing</a>
       </li>
 
-      <br>
-
-      <li>
+<!--       <li>
         <a href="/support">Support</a>
       </li>
 
-      <li>
-        <a href="/formatting">Formatting guide</a>
-      </li>
-
-      <li>
-        <a href="/news">News and updates</a>
-      </li>
+ -->      <br>
 
-      <li>
-        <a href="/developers">Developers</a>
-      </li>
-
-      <li>
-        <a href="/about">About</a>
-      </li>
+     <li><a href="/support">Support</a></li>
+      <li><a href="/about">About</a></li>
+      <li><a href="/news">News</a></li>
 
+<!--       <li><a href="/developers">Developers</a></li>
+      <li><a href="/terms">Terms of use</a></li>
+      <li><a href="/privacy">Privacy policy</a></li>
+ -->     
     </ul>
     <content>
       {{{body}}}

app/brochure/views/news/index.html

@@ -174,7 +174,7 @@
     background-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" width="612" height="612"><path d="M604.501 440.509L325.398 134.956c-5.331-5.357-12.423-7.627-19.386-7.27-6.989-.357-14.056 1.913-19.387 7.27L7.499 440.509c-9.999 10.024-9.999 26.298 0 36.323s26.223 10.024 36.222 0l262.293-287.164L568.28 476.832c9.999 10.024 26.222 10.024 36.221 0 9.999-10.023 9.999-26.298 0-36.323z"/></svg>');
 }
 </style>
-<h1>News and updates</h1>
+<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>

app/brochure/views/partials/footer.html

@@ -7,19 +7,17 @@
   </div>
     <div>
     <ul>
+      <li><a href="/support">Support</a></li>
       <li><a href="/publishing">How to use Blot</a></li>
       <li><a href="/templates">Templates</a></li>
-      <li><a href="/formatting">Formatting guide</a></li>
       <li><a href="/developers">Developers</a></li>
-      <li><a href="/news">News and updates</a></li>
     </ul>
 
     <ul>
-      <li><a href="/support">Support</a></li>
       <li><a href="/about">About</a></li>
-      <li><a href="/contact">Contact</a></li>
       <li><a href="/terms">Terms of use</a></li>
       <li><a href="/privacy">Privacy policy</a></li>
+      <li><a href="/contact">Contact</a></li>
     </ul>
     </div>
     <div>

app/brochure/views/clients/dropbox.html → app/brochure/views/publishing/clients/dropbox.html

@@ -12,7 +12,7 @@ <h1>Dropbox</h1>
 <h2>Can Blot access all the files in my Dropbox?</h2>
 
 <p>
-  Blot only requests access to your blog’s folder in your Dropbox by default. However, you can choose to grant Blot <a href="/clients/dropbox">special access to your entire Dropbox</a>. Only ever do this if you want to move your blog’s folder, or share it with other people who use Dropbox.
+  Blot only requests access to your blog’s folder in your Dropbox by default. However, you can choose to grant Blot <a href="/publishing/clients/dropbox">special access to your entire Dropbox</a>. Only ever do this if you want to move your blog’s folder, or share it with other people who use Dropbox.
 </p>
 
 <h2>Bandwidth limits</h2>
@@ -27,7 +27,7 @@ <h2>Switching client</h2>
 
 <p>You can switch seamlessly from Dropbox to another client at any point:</p>
 
-<p><ul class="clients"><li><a href="/clients/git">
+<p><ul class="clients"><li><a href="/publishing/clients/git">
     <?xml version="1.0" encoding="utf-8"?>
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 114.01 114.01">
 

app/brochure/views/clients/git.html → app/brochure/views/publishing/clients/git.html

@@ -51,7 +51,7 @@ <h2>Switching client</h2>
 
 <p>You can switch seamlessly from Git to another client at any point:</p>
 
-<p><ul class="clients"><li><a href="/clients/dropbox">
+<p><ul class="clients"><li><a href="/publishing/clients/dropbox">
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Generator: Adobe Illustrator 21.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 75.1 63.8"  xml:space="preserve">

app/brochure/views/clients/index.html → app/brochure/views/publishing/clients/index.html

@@ -3,7 +3,7 @@ <h1>Clients</h1>
 <p>Blot turns a folder into a blog. You can synchronize your blog's folder with any of the following clients. You can switch your blog seamlessly between clients at any point. Please <a href="/contact">contact me</a> if there's a client you'd like me to add.</p>
 
 <ul class="clients">
-  <li><a href="/clients/dropbox">
+  <li><a href="/publishing/clients/dropbox">
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Generator: Adobe Illustrator 21.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 75.1 63.8"  xml:space="preserve">
@@ -13,7 +13,7 @@ <h1>Clients</h1>
 </svg>
 
 <strong>Dropbox</strong><br>A file hosting service with wide support</a></li>
-  <li><a href="/clients/git">
+  <li><a href="/publishing/clients/git">
     <?xml version="1.0" encoding="utf-8"?>
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 114.01 114.01">
 

app/brochure/views/configuring/index.html → app/brochure/views/publishing/configuring.html

@@ -23,14 +23,11 @@ <h2>Permalinks</h2>
     </a></p>
 
 
+<h2>Importing posts</h2>
 
-<h2>Languages</h2>
-<p>At the moment, Blot’s dashboard, <a href="/publishing">documentation</a>, <a href="/contact">support</a> and <a href="#templates">templates</a> are available in English. However, you can translate your blog’s template yourself if you know a little HTML. </p>
-<a href="/developers" class="measure next small db bt b--black-10">
-      Guide to editing your blog’s template
-    </a>
+<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>. If you <a href="/contact">contact me</a>, I will run them for you.</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="/formatting">\(\TeX\)</a>and provides syntax highlighting for code.</p>
+<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>
 

app/brochure/views/configuring/domain.html → app/brochure/views/publishing/domain.html

@@ -22,4 +22,26 @@ <h2>Use your apex domain</h2>
   </li>
 </ol>
 
-<p>If you cannot create an <code>ALIAS</code> record, I recommend you use the <code>www</code> subdomain, then set up a redirect from the apex domain to the subdomain.</p>
+<p>If you cannot create an <code>ALIAS</code> record, I recommend you use the <code>www</code> subdomain, then set up a redirect from the apex domain to the subdomain.</p>
+
+<h2>Quick reference</h2>
+<table>
+  <thead>
+    <td>DNS record type</td>
+    <td>Host</td>
+    <td>Value</td>
+  <tr>
+    <td>CNAME</td> 
+    <td>www</td>
+    <td>blot.im</td>
+  </tr>
+  <tr>
+    <td>ALIAS</td> 
+    <td>*</td>
+    <td>blot.im</td>
+  </tr>
+    <tr>
+    <td>A</td> 
+    <td>*</td>
+    <td>54.191.179.131</td>
+  </tr>

app/brochure/views/publishing/formatting/index.html

@@ -0,0 +1,12 @@
+<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>
+
+
+<ul class="clients">
+  <li><a href="/publishing/formatting/markdown"><strong>Markdown</strong><br>  A lightweight markup language with plain text formatting syntax.</a> </li>
+  <li><a href="/publishing/formatting/tex"><strong>\(\TeX\)</strong><br> A math typesetting library with powerful formatting features.</a> </li>
+  <li><a href="/publishing/formatting/layout-tags"><strong>Layout</strong><br> A custom Markdown extension which offers simple layout directives.</a> </li>
+</ul>
+
+