reworded file tree docs

This commit is contained in:
Heydon Pickering 2017-07-17 08:57:57 +01:00
parent db59e0a845
commit 8be4b01aad
5 changed files with 13 additions and 5 deletions

View File

@ -17,10 +17,13 @@ The file tree is described using a markdown nested list structure:
* Level 3 folder * Level 3 folder
* Level 4 file * Level 4 file
* Level 4 file * Level 4 file
* Level 3 file
* Level 2 folder * Level 2 folder
* Level 3 file * Level 3 file
* Level 3 file * Level 3 file
* Level 3 file * Level 3 file
* Level 2 file
* Level 1 file
{{% /fileTree %}} {{% /fileTree %}}
{{</codeBlock>}} {{</codeBlock>}}
@ -36,6 +39,7 @@ This is drawn in the following fashion, but preserves the underlying nested list
* Level 3 folder * Level 3 folder
* Level 4 file * Level 4 file
* Level 4 file * Level 4 file
* Level 3 file
* Level 2 folder * Level 2 folder
* Level 3 file * Level 3 file
* Level 3 file * Level 3 file
@ -45,5 +49,5 @@ This is drawn in the following fashion, but preserves the underlying nested list
{{% /fileTree %}} {{% /fileTree %}}
{{% warning %}} {{% warning %}}
The only reliable way to nest unordered lists in markdown is to indent the nested item by exactly four spaces. Using tabs and less than four spaces are unreliable methods. The only reliable way to nest unordered lists in markdown is to indent the nested item by exactly four spaces. Using tabs or less than four spaces are unreliable methods.
{{% /warning %}} {{% /warning %}}

View File

@ -106,7 +106,7 @@ npm run start The cmd shortcode currently only supports single commands. If y
<guid>https://heydon.github.io/infusion/patterns/coding/file-trees/</guid> <guid>https://heydon.github.io/infusion/patterns/coding/file-trees/</guid>
<description>Representing folder/file structures is simple and accessible in Infusion. Which is just as well, because some components may need to conform to a certain folder structure. <description>Representing folder/file structures is simple and accessible in Infusion. Which is just as well, because some components may need to conform to a certain folder structure.
The file tree is described using a markdown nested list structure: The file tree is described using a markdown nested list structure:
&amp;#x7b;{% fileTree %}} * Level 1 folder * Level 2 file * Level 2 folder * Level 3 file * Level 3 folder * Level 4 file * Level 3 folder * Level 4 file * Level 4 file * Level 2 folder * Level 3 file * Level 3 file * Level 3 file &amp;#x7b;{% /fileTree %}} This is drawn in the following fashion, but preserves the underlying nested list structure for assistive technologies such as screen readers:</description> &amp;#x7b;{% fileTree %}} * Level 1 folder * Level 2 file * Level 2 folder * Level 3 file * Level 3 folder * Level 4 file * Level 3 folder * Level 4 file * Level 4 file * Level 3 file * Level 2 folder * Level 3 file * Level 3 file * Level 3 file * Level 2 file * Level 1 file &amp;#x7b;{% /fileTree %}} This is drawn in the following fashion, but preserves the underlying nested list structure for assistive technologies such as screen readers:</description>
</item> </item>
<item> <item>

View File

@ -294,10 +294,13 @@
* Level 3 folder * Level 3 folder
* Level 4 file * Level 4 file
* Level 4 file * Level 4 file
* Level 3 file
* Level 2 folder * Level 2 folder
* Level 3 file * Level 3 file
* Level 3 file * Level 3 file
* Level 3 file * Level 3 file
* Level 2 file
* Level 1 file
&#x7b;{% /fileTree %}} &#x7b;{% /fileTree %}}
</code></pre> </code></pre>
@ -325,6 +328,7 @@
<li>Level 4 file</li> <li>Level 4 file</li>
<li>Level 4 file</li> <li>Level 4 file</li>
</ul></li> </ul></li>
<li>Level 3 file</li>
</ul></li> </ul></li>
<li>Level 2 folder <li>Level 2 folder
@ -346,7 +350,7 @@
<svg aria-hidden="true" height="41.646" width="48.43" viewBox="0 0 48.430474 41.646302"> <svg aria-hidden="true" height="41.646" width="48.43" viewBox="0 0 48.430474 41.646302">
<use xlink:href="#warning"></use> <use xlink:href="#warning"></use>
</svg> </svg>
<p>The only reliable way to nest unordered lists in markdown is to indent the nested item by exactly four spaces. Using tabs and less than four spaces are unreliable methods.</p> <p>The only reliable way to nest unordered lists in markdown is to indent the nested item by exactly four spaces. Using tabs or less than four spaces are unreliable methods.</p>
</div> </div>
</aside> </aside>

View File

@ -74,7 +74,7 @@ npm run start The cmd shortcode currently only supports single commands. If y
<guid>https://heydon.github.io/infusion/patterns/coding/file-trees/</guid> <guid>https://heydon.github.io/infusion/patterns/coding/file-trees/</guid>
<description>Representing folder/file structures is simple and accessible in Infusion. Which is just as well, because some components may need to conform to a certain folder structure. <description>Representing folder/file structures is simple and accessible in Infusion. Which is just as well, because some components may need to conform to a certain folder structure.
The file tree is described using a markdown nested list structure: The file tree is described using a markdown nested list structure:
&amp;#x7b;{% fileTree %}} * Level 1 folder * Level 2 file * Level 2 folder * Level 3 file * Level 3 folder * Level 4 file * Level 3 folder * Level 4 file * Level 4 file * Level 2 folder * Level 3 file * Level 3 file * Level 3 file &amp;#x7b;{% /fileTree %}} This is drawn in the following fashion, but preserves the underlying nested list structure for assistive technologies such as screen readers:</description> &amp;#x7b;{% fileTree %}} * Level 1 folder * Level 2 file * Level 2 folder * Level 3 file * Level 3 folder * Level 4 file * Level 3 folder * Level 4 file * Level 4 file * Level 3 file * Level 2 folder * Level 3 file * Level 3 file * Level 3 file * Level 2 file * Level 1 file &amp;#x7b;{% /fileTree %}} This is drawn in the following fashion, but preserves the underlying nested list structure for assistive technologies such as screen readers:</description>
</item> </item>
<item> <item>

File diff suppressed because one or more lines are too long