Browse Source

print version archetype and doc change

Heydon Pickering 8 years ago
parent
commit
074c01a0ee

+ 3 - 1
content/patterns/writing/library-structure.md

@@ -8,13 +8,15 @@ Before you can set about documenting patterns, you need to know where everything
 {{% fileTree %}}
 {{% fileTree %}}
 * content
 * content
     * \_index.md
     * \_index.md
+    * print-version.md
     * patterns
     * patterns
         * name-of-my-pattern.md
         * name-of-my-pattern.md
         * name-of-my-other-pattern.md
         * name-of-my-other-pattern.md
 {{% /fileTree %}}
 {{% /fileTree %}}
 
 
 * **/content** - This is where all of your content lives. You won't need to visit any other folders very frequently.
 * **/content** - This is where all of your content lives. You won't need to visit any other folders very frequently.
-* **_index.md** — This is the content for your home page.
+* **_index.md** — This is the content file for your home page.
+* **print-version.md** — This is a placeholder for the single-page / print-friendly version of you library. Leave this file as it is.
 * **/patterns** — This is the folder where individual pattern files are kept.
 * **/patterns** — This is the folder where individual pattern files are kept.
 
 
 ## Subsections
 ## Subsections

+ 2 - 0
content/print-version.md

@@ -1,6 +1,8 @@
 +++
 +++
+date = "2017-07-29T22:48:43+01:00"
 title = "Infusion"
 title = "Infusion"
 type = "print-version"
 type = "print-version"
+
 +++
 +++
 
 
 You don't want to edit this file :-)
 You don't want to edit this file :-)

+ 10 - 10
docs/index.xml

@@ -30,7 +30,7 @@ So, this…
       
       
       <guid>https://heydon.github.io/infusion/patterns/writing/library-structure/</guid>
       <guid>https://heydon.github.io/infusion/patterns/writing/library-structure/</guid>
       <description>Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:
       <description>Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:
- content  _index.md patterns  name-of-my-pattern.md name-of-my-other-pattern.md      /content - This is where all of your content lives. You won&amp;rsquo;t need to visit any other folders very frequently. _index.md — This is the content for your home page. /patterns — This is the folder where individual pattern files are kept.</description>
+ content  _index.md print-version.md patterns  name-of-my-pattern.md name-of-my-other-pattern.md      /content - This is where all of your content lives. You won&amp;rsquo;t need to visit any other folders very frequently. _index.md — This is the content file for your home page. print-version.md — This is a placeholder for the single-page / print-friendly version of you library.</description>
     </item>
     </item>
     
     
     <item>
     <item>
@@ -75,6 +75,15 @@ The expandable shortcode takes three parameters:
  label — This is the label for the the section heading. level — This is the heading level (e.</description>
  label — This is the label for the the section heading. level — This is the heading level (e.</description>
     </item>
     </item>
     
     
+    <item>
+      <title>Infusion</title>
+      <link>https://heydon.github.io/infusion/print-version/</link>
+      <pubDate>Sat, 29 Jul 2017 22:48:43 +0100</pubDate>
+      
+      <guid>https://heydon.github.io/infusion/print-version/</guid>
+      <description>You don&amp;rsquo;t want to edit this file :-)</description>
+    </item>
+    
     <item>
     <item>
       <title>Color palettes</title>
       <title>Color palettes</title>
       <link>https://heydon.github.io/infusion/patterns/coding/color-palettes/</link>
       <link>https://heydon.github.io/infusion/patterns/coding/color-palettes/</link>
@@ -129,15 +138,6 @@ The file tree is described using a markdown nested list structure:
 &amp;#x7b;{&amp;lt;youtube w7Ft2ymGmfc}}  </description>
 &amp;#x7b;{&amp;lt;youtube w7Ft2ymGmfc}}  </description>
     </item>
     </item>
     
     
-    <item>
-      <title>Infusion</title>
-      <link>https://heydon.github.io/infusion/print-version/</link>
-      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
-      
-      <guid>https://heydon.github.io/infusion/print-version/</guid>
-      <description>You don&amp;rsquo;t want to edit this file :-)</description>
-    </item>
-    
     <item>
     <item>
       <title>Installation</title>
       <title>Installation</title>
       <link>https://heydon.github.io/infusion/patterns/installation/</link>
       <link>https://heydon.github.io/infusion/patterns/installation/</link>

+ 1 - 1
docs/patterns/writing/index.xml

@@ -17,7 +17,7 @@
       
       
       <guid>https://heydon.github.io/infusion/patterns/writing/library-structure/</guid>
       <guid>https://heydon.github.io/infusion/patterns/writing/library-structure/</guid>
       <description>Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:
       <description>Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:
- content  _index.md patterns  name-of-my-pattern.md name-of-my-other-pattern.md      /content - This is where all of your content lives. You won&amp;rsquo;t need to visit any other folders very frequently. _index.md — This is the content for your home page. /patterns — This is the folder where individual pattern files are kept.</description>
+ content  _index.md print-version.md patterns  name-of-my-pattern.md name-of-my-other-pattern.md      /content - This is where all of your content lives. You won&amp;rsquo;t need to visit any other folders very frequently. _index.md — This is the content file for your home page. print-version.md — This is a placeholder for the single-page / print-friendly version of you library.</description>
     </item>
     </item>
     
     
     <item>
     <item>

+ 3 - 1
docs/patterns/writing/library-structure/index.html

@@ -307,6 +307,7 @@
 
 
 <ul>
 <ul>
 <li>_index.md</li>
 <li>_index.md</li>
+<li>print-version.md</li>
 <li>patterns
 <li>patterns
 
 
 <ul>
 <ul>
@@ -321,7 +322,8 @@
 
 
 <ul>
 <ul>
 <li><strong>/content</strong> - This is where all of your content lives. You won&rsquo;t need to visit any other folders very frequently.</li>
 <li><strong>/content</strong> - This is where all of your content lives. You won&rsquo;t need to visit any other folders very frequently.</li>
-<li><strong>_index.md</strong> — This is the content for your home page.</li>
+<li><strong>_index.md</strong> — This is the content file for your home page.</li>
+<li><strong>print-version.md</strong> — This is a placeholder for the single-page / print-friendly version of you library. Leave this file as it is.</li>
 <li><strong>/patterns</strong> — This is the folder where individual pattern files are kept.</li>
 <li><strong>/patterns</strong> — This is the folder where individual pattern files are kept.</li>
 </ul>
 </ul>
 
 

+ 3 - 1
docs/print-version/index.html

@@ -467,6 +467,7 @@ theme = "infusion"
 
 
 <ul>
 <ul>
 <li>_index.md</li>
 <li>_index.md</li>
+<li>print-version.md</li>
 <li>patterns
 <li>patterns
 
 
 <ul>
 <ul>
@@ -481,7 +482,8 @@ theme = "infusion"
 
 
 <ul>
 <ul>
 <li><strong>/content</strong> - This is where all of your content lives. You won&rsquo;t need to visit any other folders very frequently.</li>
 <li><strong>/content</strong> - This is where all of your content lives. You won&rsquo;t need to visit any other folders very frequently.</li>
-<li><strong>_index.md</strong> — This is the content for your home page.</li>
+<li><strong>_index.md</strong> — This is the content file for your home page.</li>
+<li><strong>print-version.md</strong> — This is a placeholder for the single-page / print-friendly version of you library. Leave this file as it is.</li>
 <li><strong>/patterns</strong> — This is the folder where individual pattern files are kept.</li>
 <li><strong>/patterns</strong> — This is the folder where individual pattern files are kept.</li>
 </ul>
 </ul>
 
 

File diff suppressed because it is too large
+ 0 - 0
docs/service-worker.js


+ 5 - 4
docs/sitemap.xml

@@ -34,6 +34,11 @@
     <loc>https://heydon.github.io/infusion/patterns/writing/expandable-sections/</loc>
     <loc>https://heydon.github.io/infusion/patterns/writing/expandable-sections/</loc>
   </url>
   </url>
   
   
+  <url>
+    <loc>https://heydon.github.io/infusion/print-version/</loc>
+    <lastmod>2017-07-29T22:48:43+01:00</lastmod>
+  </url>
+  
   <url>
   <url>
     <loc>https://heydon.github.io/infusion/</loc>
     <loc>https://heydon.github.io/infusion/</loc>
     <lastmod>2017-06-26T18:27:58+01:00</lastmod>
     <lastmod>2017-06-26T18:27:58+01:00</lastmod>
@@ -68,10 +73,6 @@
     <loc>https://heydon.github.io/infusion/patterns/media/including-videos/</loc>
     <loc>https://heydon.github.io/infusion/patterns/media/including-videos/</loc>
   </url>
   </url>
   
   
-  <url>
-    <loc>https://heydon.github.io/infusion/print-version/</loc>
-  </url>
-  
   <url>
   <url>
     <loc>https://heydon.github.io/infusion/patterns/installation/</loc>
     <loc>https://heydon.github.io/infusion/patterns/installation/</loc>
   </url>
   </url>

+ 1 - 1
package.json

@@ -6,7 +6,7 @@
   "scripts": {
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "test": "echo \"Error: no test specified\" && exit 1",
     "serve": "hugo server --baseURL http://localhost:1313",
     "serve": "hugo server --baseURL http://localhost:1313",
-    "clean": "rm -rf content && mkdir content && mkdir content/patterns && hugo new patterns/pattern.md && hugo new _index.md",
+    "clean": "rm -rf content && mkdir content && mkdir content/patterns && hugo new patterns/pattern.md && hugo new _index.md && hugo new print-version.md --kind print-version",
     "build": "rm -rfv docs/* && hugo && sw-precache --root=docs && git add -A"
     "build": "rm -rfv docs/* && hugo && sw-precache --root=docs && git add -A"
   },
   },
   "pre-commit": [
   "pre-commit": [

+ 1 - 1
themes/infusion/archetypes/patterns.md

@@ -6,5 +6,5 @@ tags = ["example tag", "another tag"]
 You can just write **markdown** here. But don't forget there are lots of shortcodes to help you with writing and showing off code too. See [the documentation for **Infusion**](https://heydon.github.io/infusion/) for full details.
 You can just write **markdown** here. But don't forget there are lots of shortcodes to help you with writing and showing off code too. See [the documentation for **Infusion**](https://heydon.github.io/infusion/) for full details.
 
 
 {{% note %}}
 {{% note %}}
-Here's an example of a note shortcode, for adding little "oh and also" bits to your patterns' documentation.
+Here's an example of a note shortcode for adding little "oh and also" notes to your patterns' documentation.
 {{% /note %}}
 {{% /note %}}

+ 6 - 0
themes/infusion/archetypes/print-version.md

@@ -0,0 +1,6 @@
++++
+title = "Infusion"
+type = "print-version"
++++
+
+You don't want to edit this file :-)

Some files were not shown because too many files changed in this diff