浏览代码

moved to documentation terminology

Heydon Pickering 8 年之前
父节点
当前提交
ed547130f3

+ 2 - 1
README.md

@@ -1,6 +1,7 @@
 # Infusion
 
-**Infusion** is a pattern library builder for inclusive designers, and those who want to be inclusive designers.
+**Infusion** is a documentation builder for inclusive designers, and those who want to be inclusive designers. Build accessible pattern libraries and all sorts of other docs.
 
 * [Documentation →](https://thepaciellogroup.github.io/infusion)
 * [Contributing →](https://github.com/ThePacielloGroup/infusion/blob/master/CONTRIBUTING.md)
+* [Help forum](https://groups.google.com/forum/#!forum/infusion-pattern-library-builder)

+ 1 - 1
content/_index.md

@@ -3,7 +3,7 @@ date = "2017-06-26T18:27:58+01:00"
 title = "The Infusion Pattern Library Builder"
 +++
 
-Welcome to **Infusion**: a pattern library builder for inclusive designers and those trying to be inclusive designers. These are **Infusion's** docs, but they are also an example of a pattern library built with **Infusion**. Here are some of its features:
+Welcome to **Infusion**: a documentation builder for inclusive designers and those trying to be inclusive designers. These are **Infusion's** docs, but they are also an example of a site built with **Infusion**. Here are some of its features:
 
 {{% ticks %}}
 * Built with [Hugo](https://gohugo.io/), so easy to structure content and fast to compile it

+ 2 - 2
content/patterns/writing/library-structure.md

@@ -3,7 +3,7 @@ title = "Library structure"
 weight = 1
 +++
 
-Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:
+Before you can set about making documentation, you need to know where everything goes. The simplest folder structure looks like this:
 
 {{% fileTree %}}
 * content
@@ -17,7 +17,7 @@ Before you can set about documenting patterns, you need to know where everything
 * **/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 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 content files are kept. **Infusion** refers to each individual documentation file/page as a "pattern". 
 
 ## Subsections
 

+ 2 - 2
content/patterns/writing/markdown-and-metadata.md

@@ -4,7 +4,7 @@ weight = 3
 tags = ['metadata', 'markdown']
 +++
 
-In **Infusion**, design patterns are documented using markdown. To create a new pattern file, just add a file with the `.md` extension to the `/patterns` folder. It's recommended you use "kebab case" to name the file ( words separated by hyphens). For example, a pattern with the title "Menu button" should probably have the filename `menu-button`. Then you get a nice clean URL: `username.github.io/your-library/patterns/menu-button`.
+In **Infusion** everything is documented using markdown, as a "pattern". To create a new pattern file, just add a file with the `.md` extension to the `content/patterns` folder. It's recommended you use "kebab case" to name the file (words separated by hyphens). For example, a pattern with the title "Menu button" should probably have the filename `menu-button`. Then you get a nice clean URL: `username.github.io/your-library/patterns/menu-button`.
 
 If you're not familiar with writing markdown, there are a number of tutorials available. One of the best is [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) offered by Github. There's also a [nice cheatsheet here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
 
@@ -19,7 +19,7 @@ title = "Menu button"
 ```
 
 {{% note %}}
-The title automatically becomes the page's main `<h1>` heading. The highest heading level you should use in the body of your markdown file is `<h2>`.
+The title automatically becomes the page's main `<h1>` heading. The highest heading level you should use in the body of your markdown file is therefore `<h2>`.
 {{% /note %}}
 
 ### Tags

+ 1 - 1
content/patterns/writing/references.md

@@ -4,7 +4,7 @@ title = "References"
 
 ## Cross-references
 
-**Infusion** provides an easy mechanism to cross-reference patterns, by title, using the `pattern` shortcode. For example, I can reference the {{% pattern "Notes & warnings" %}} pattern. Here's what the markdown looks like, including the shortcode:
+**Infusion** identifies the main content files in your documentation as _patterns_, and they're kept in the **content → patterns** folder. It's easy to cross-reference patterns using the `pattern` shortcode. For example, I can reference the {{% pattern "Notes & warnings" %}} pattern. Here's what the markdown looks like, including the shortcode:
 
 {{<codeBlock>}}
 I can reference the &#x7b;{% pattern "Notes & warnings" %}} pattern here.

+ 1 - 1
docs/index.html

@@ -394,7 +394,7 @@
           
   <main id="main">
     <h1>The Infusion Pattern Library Builder</h1>
-    <p>Welcome to <strong>Infusion</strong>: a pattern library builder for inclusive designers and those trying to be inclusive designers. These are <strong>Infusion&rsquo;s</strong> docs, but they are also an example of a pattern library built with <strong>Infusion</strong>. Here are some of its features:</p>
+    <p>Welcome to <strong>Infusion</strong>: a documentation builder for inclusive designers and those trying to be inclusive designers. These are <strong>Infusion&rsquo;s</strong> docs, but they are also an example of a site built with <strong>Infusion</strong>. Here are some of its features:</p>
 
 <div class="ticks">
   <ul>

+ 3 - 3
docs/index.xml

@@ -41,7 +41,7 @@ brew install hugo Alternatively, you can manually install Hugo from a package. Y
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.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 making documentation, you need to know where everything goes. The simplest folder structure looks like this:
  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>
     
@@ -72,7 +72,7 @@ CodePen Infusion offers a couple of ways to do this. The first is by embedding C
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.github.io/infusion/patterns/writing/markdown-and-metadata/</guid>
-      <description>In Infusion, design patterns are documented using markdown. To create a new pattern file, just add a file with the .md extension to the /patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file ( words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
+      <description>In Infusion everything is documented using markdown, as a &amp;ldquo;pattern&amp;rdquo;. To create a new pattern file, just add a file with the .md extension to the content/patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file (words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
 If you&amp;rsquo;re not familiar with writing markdown, there are a number of tutorials available.</description>
     </item>
     
@@ -219,7 +219,7 @@ Notes You may wish to pick out some content in your pattern&amp;rsquo;s document
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.github.io/infusion/patterns/writing/references/</guid>
-      <description>Cross-references Infusion provides an easy mechanism to cross-reference patterns, by title, using the pattern shortcode. For example, I can reference the  Notes &amp;amp; warnings pattern. Here&amp;rsquo;s what the markdown looks like, including the shortcode:
+      <description>Cross-references Infusion identifies the main content files in your documentation as patterns, and they&amp;rsquo;re kept in the content → patterns folder. It&amp;rsquo;s easy to cross-reference patterns using the pattern shortcode. For example, I can reference the  Notes &amp;amp; warnings pattern. Here&amp;rsquo;s what the markdown looks like, including the shortcode:
 I can reference the &amp;#x7b;{% pattern &#34;Notes &amp; warnings&#34; %}} pattern here.  This saves you having to worry about pathing and decorates the generated link with a bookmark icon, identifying the link as a pattern reference visually.</description>
     </item>
     

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

@@ -16,7 +16,7 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.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 making documentation, you need to know where everything goes. The simplest folder structure looks like this:
  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>
     
@@ -26,7 +26,7 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.github.io/infusion/patterns/writing/markdown-and-metadata/</guid>
-      <description>In Infusion, design patterns are documented using markdown. To create a new pattern file, just add a file with the .md extension to the /patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file ( words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
+      <description>In Infusion everything is documented using markdown, as a &amp;ldquo;pattern&amp;rdquo;. To create a new pattern file, just add a file with the .md extension to the content/patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file (words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
 If you&amp;rsquo;re not familiar with writing markdown, there are a number of tutorials available.</description>
     </item>
     
@@ -57,7 +57,7 @@ Notes You may wish to pick out some content in your pattern&amp;rsquo;s document
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.github.io/infusion/patterns/writing/references/</guid>
-      <description>Cross-references Infusion provides an easy mechanism to cross-reference patterns, by title, using the pattern shortcode. For example, I can reference the  Notes &amp;amp; warnings pattern. Here&amp;rsquo;s what the markdown looks like, including the shortcode:
+      <description>Cross-references Infusion identifies the main content files in your documentation as patterns, and they&amp;rsquo;re kept in the content → patterns folder. It&amp;rsquo;s easy to cross-reference patterns using the pattern shortcode. For example, I can reference the  Notes &amp;amp; warnings pattern. Here&amp;rsquo;s what the markdown looks like, including the shortcode:
 I can reference the &amp;#x7b;{% pattern &#34;Notes &amp; warnings&#34; %}} pattern here.  This saves you having to worry about pathing and decorates the generated link with a bookmark icon, identifying the link as a pattern reference visually.</description>
     </item>
     

+ 2 - 2
docs/patterns/writing/library-structure/index.html

@@ -404,7 +404,7 @@
     
     
 
-<p>Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:</p>
+<p>Before you can set about making documentation, you need to know where everything goes. The simplest folder structure looks like this:</p>
 
 <div class="file-tree">
   <ul>
@@ -429,7 +429,7 @@
 <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 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 content files are kept. <strong>Infusion</strong> refers to each individual documentation file/page as a &ldquo;pattern&rdquo;.</li>
 </ul>
 
 <h2 id="subsections">Subsections</h2>

+ 2 - 2
docs/patterns/writing/markdown-and-metadata/index.html

@@ -433,7 +433,7 @@
     
     
 
-<p>In <strong>Infusion</strong>, design patterns are documented using markdown. To create a new pattern file, just add a file with the <code>.md</code> extension to the <code>/patterns</code> folder. It&rsquo;s recommended you use &ldquo;kebab case&rdquo; to name the file ( words separated by hyphens). For example, a pattern with the title &ldquo;Menu button&rdquo; should probably have the filename <code>menu-button</code>. Then you get a nice clean URL: <code>username.github.io/your-library/patterns/menu-button</code>.</p>
+<p>In <strong>Infusion</strong> everything is documented using markdown, as a &ldquo;pattern&rdquo;. To create a new pattern file, just add a file with the <code>.md</code> extension to the <code>content/patterns</code> folder. It&rsquo;s recommended you use &ldquo;kebab case&rdquo; to name the file (words separated by hyphens). For example, a pattern with the title &ldquo;Menu button&rdquo; should probably have the filename <code>menu-button</code>. Then you get a nice clean URL: <code>username.github.io/your-library/patterns/menu-button</code>.</p>
 
 <p>If you&rsquo;re not familiar with writing markdown, there are a number of tutorials available. One of the best is <a href="https://guides.github.com/features/mastering-markdown/">Mastering Markdown</a> offered by Github. There&rsquo;s also a <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">nice cheatsheet here</a>.</p>
 
@@ -451,7 +451,7 @@ title = &quot;Menu button&quot;
     <svg aria-hidden="true" viewBox="0 0 41.667306 41.66729" focusable="false">
       <use xlink:href="#info"></use>
     </svg>
-    <p>The title automatically becomes the page&rsquo;s main <code>&lt;h1&gt;</code> heading. The highest heading level you should use in the body of your markdown file is <code>&lt;h2&gt;</code>.</p>
+    <p>The title automatically becomes the page&rsquo;s main <code>&lt;h1&gt;</code> heading. The highest heading level you should use in the body of your markdown file is therefore <code>&lt;h2&gt;</code>.</p>
 
   </div>
 </aside>

+ 1 - 1
docs/patterns/writing/references/index.html

@@ -431,7 +431,7 @@
 
 <h2 id="cross-references">Cross-references</h2>
 
-<p><strong>Infusion</strong> provides an easy mechanism to cross-reference patterns, by title, using the <code>pattern</code> shortcode. For example, I can reference the <a class="pattern-link" href="https://thepaciellogroup.github.io/infusion/patterns/writing/notes-and-warnings/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50" focusable="false"> <use xlink:href="#bookmark"></use> </svg>Notes &amp; warnings</a> pattern. Here&rsquo;s what the markdown looks like, including the shortcode:</p>
+<p><strong>Infusion</strong> identifies the main content files in your documentation as <em>patterns</em>, and they&rsquo;re kept in the <strong>content → patterns</strong> folder. It&rsquo;s easy to cross-reference patterns using the <code>pattern</code> shortcode. For example, I can reference the <a class="pattern-link" href="https://thepaciellogroup.github.io/infusion/patterns/writing/notes-and-warnings/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50" focusable="false"> <use xlink:href="#bookmark"></use> </svg>Notes &amp; warnings</a> pattern. Here&rsquo;s what the markdown looks like, including the shortcode:</p>
 
 <pre class=" "><code  data-codeblock-shortcode>
 I can reference the &#x7b;{% pattern "Notes & warnings" %}} pattern here.

+ 5 - 5
docs/print-version/index.html

@@ -722,7 +722,7 @@ theme = "infusion"
             </h1>
             
 
-<p>Before you can set about documenting patterns, you need to know where everything goes. The simplest folder structure looks like this:</p>
+<p>Before you can set about making documentation, you need to know where everything goes. The simplest folder structure looks like this:</p>
 
 <div class="file-tree">
   <ul>
@@ -747,7 +747,7 @@ theme = "infusion"
 <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 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 content files are kept. <strong>Infusion</strong> refers to each individual documentation file/page as a &ldquo;pattern&rdquo;.</li>
 </ul>
 
 <h2 id="subsections">Subsections</h2>
@@ -812,7 +812,7 @@ title = &quot;Popups&quot;
             </h1>
             
 
-<p>In <strong>Infusion</strong>, design patterns are documented using markdown. To create a new pattern file, just add a file with the <code>.md</code> extension to the <code>/patterns</code> folder. It&rsquo;s recommended you use &ldquo;kebab case&rdquo; to name the file ( words separated by hyphens). For example, a pattern with the title &ldquo;Menu button&rdquo; should probably have the filename <code>menu-button</code>. Then you get a nice clean URL: <code>username.github.io/your-library/patterns/menu-button</code>.</p>
+<p>In <strong>Infusion</strong> everything is documented using markdown, as a &ldquo;pattern&rdquo;. To create a new pattern file, just add a file with the <code>.md</code> extension to the <code>content/patterns</code> folder. It&rsquo;s recommended you use &ldquo;kebab case&rdquo; to name the file (words separated by hyphens). For example, a pattern with the title &ldquo;Menu button&rdquo; should probably have the filename <code>menu-button</code>. Then you get a nice clean URL: <code>username.github.io/your-library/patterns/menu-button</code>.</p>
 
 <p>If you&rsquo;re not familiar with writing markdown, there are a number of tutorials available. One of the best is <a href="https://guides.github.com/features/mastering-markdown/">Mastering Markdown</a> offered by Github. There&rsquo;s also a <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">nice cheatsheet here</a>.</p>
 
@@ -830,7 +830,7 @@ title = &quot;Menu button&quot;
     <svg aria-hidden="true" viewBox="0 0 41.667306 41.66729" focusable="false">
       <use xlink:href="#info"></use>
     </svg>
-    <p>The title automatically becomes the page&rsquo;s main <code>&lt;h1&gt;</code> heading. The highest heading level you should use in the body of your markdown file is <code>&lt;h2&gt;</code>.</p>
+    <p>The title automatically becomes the page&rsquo;s main <code>&lt;h1&gt;</code> heading. The highest heading level you should use in the body of your markdown file is therefore <code>&lt;h2&gt;</code>.</p>
 
   </div>
 </aside>
@@ -1065,7 +1065,7 @@ This is a warning! It's about something the reader should be careful to do or to
 
 <h2 id="cross-references">Cross-references</h2>
 
-<p><strong>Infusion</strong> provides an easy mechanism to cross-reference patterns, by title, using the <code>pattern</code> shortcode. For example, I can reference the <a class="pattern-link" href="https://thepaciellogroup.github.io/infusion/patterns/writing/notes-and-warnings/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50" focusable="false"> <use xlink:href="#bookmark"></use> </svg>Notes &amp; warnings</a> pattern. Here&rsquo;s what the markdown looks like, including the shortcode:</p>
+<p><strong>Infusion</strong> identifies the main content files in your documentation as <em>patterns</em>, and they&rsquo;re kept in the <strong>content → patterns</strong> folder. It&rsquo;s easy to cross-reference patterns using the <code>pattern</code> shortcode. For example, I can reference the <a class="pattern-link" href="https://thepaciellogroup.github.io/infusion/patterns/writing/notes-and-warnings/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50" focusable="false"> <use xlink:href="#bookmark"></use> </svg>Notes &amp; warnings</a> pattern. Here&rsquo;s what the markdown looks like, including the shortcode:</p>
 
 <pre class=" "><code  data-codeblock-shortcode>
 I can reference the &#x7b;{% pattern "Notes & warnings" %}} pattern here.

文件差异内容过多而无法显示
+ 0 - 0
docs/service-worker.js


+ 1 - 1
docs/tags/markdown/index.xml

@@ -16,7 +16,7 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.github.io/infusion/patterns/writing/markdown-and-metadata/</guid>
-      <description>In Infusion, design patterns are documented using markdown. To create a new pattern file, just add a file with the .md extension to the /patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file ( words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
+      <description>In Infusion everything is documented using markdown, as a &amp;ldquo;pattern&amp;rdquo;. To create a new pattern file, just add a file with the .md extension to the content/patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file (words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
 If you&amp;rsquo;re not familiar with writing markdown, there are a number of tutorials available.</description>
     </item>
     

+ 1 - 1
docs/tags/metadata/index.xml

@@ -16,7 +16,7 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://thepaciellogroup.github.io/infusion/patterns/writing/markdown-and-metadata/</guid>
-      <description>In Infusion, design patterns are documented using markdown. To create a new pattern file, just add a file with the .md extension to the /patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file ( words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
+      <description>In Infusion everything is documented using markdown, as a &amp;ldquo;pattern&amp;rdquo;. To create a new pattern file, just add a file with the .md extension to the content/patterns folder. It&amp;rsquo;s recommended you use &amp;ldquo;kebab case&amp;rdquo; to name the file (words separated by hyphens). For example, a pattern with the title &amp;ldquo;Menu button&amp;rdquo; should probably have the filename menu-button. Then you get a nice clean URL: username.github.io/your-library/patterns/menu-button.
 If you&amp;rsquo;re not familiar with writing markdown, there are a number of tutorials available.</description>
     </item>
     

部分文件因为文件数量过多而无法显示