diff --git a/docs/index.html b/docs/index.html index 106338e..a1e1c46 100644 --- a/docs/index.html +++ b/docs/index.html @@ -139,7 +139,7 @@ - + Menu @@ -150,28 +150,36 @@ - + + + Installation - + + + Library setup - + + + Serving - + + + Printing @@ -183,42 +191,54 @@ - + + + Library structure - + + + Markdown & metadata - + + + Expandable sections - + + + Notes & warnings - + + + References - + + + Tables of contents @@ -232,14 +252,18 @@ - + + + Including images - + + + Including videos @@ -253,49 +277,63 @@ - + + + Code blocks - + + + Demo embedding - + + + Writing inline demos - + + + Color palettes - + + + Command line - + + + File trees - + + + Tested using... @@ -330,7 +368,7 @@ -To get started, take a look at Installation. +To get started, take a look at Installation. diff --git a/docs/index.xml b/docs/index.xml index 4d92f88..c1d52f2 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -62,7 +62,7 @@ CodePen Infusion offers a couple of ways to do this. The first is by embedding C Mon, 01 Jan 0001 00:00:00 +0000 https://heydon.github.io/infusion/patterns/library-setup/ - By now, you should have followed the Installation instructions. You should have Hugo and Node installed, and a local copy of a forked version of Infusion. You should also have run npm install in the root of that codebase. + By now, you should have followed the Installation instructions. You should have Hugo and Node installed, and a local copy of a forked version of Infusion. You should also have run npm install in the root of that codebase. “Cleaning” the content folder Before you can start documenting patterns, there are a few things still to do in order to get set up. At the moment, your version of Infusion is a facsimile of the original, containing all this documentation content. @@ -103,7 +103,7 @@ Infusion offers another option: a special demo shortcode that allows you to writ Mon, 01 Jan 0001 00:00:00 +0000 https://heydon.github.io/infusion/patterns/printing/ - Infusion’s output site includes a one-page Print version of the generated library, available at /print-version. So, if your library base URL is https://yourName.github.io/your-library, you can print the whole library — to PDF if wanted — from the following address: + Infusion’s output site includes a one-page Print version of the generated library, available at /print-version. So, if your library base URL is https://yourName.github.io/your-library, you can print the whole library — to PDF if wanted — from the following address: https://yourName.github.io/your-library/print-version Print styles are also provided for individual pattern pages so, if you wanted to print off a single pattern document, go ahead! @@ -198,7 +198,7 @@ Notes You may wish to pick out some content in your pattern’s document Mon, 01 Jan 0001 00:00:00 +0000 https://heydon.github.io/infusion/patterns/writing/references/ - Cross-references Infusion provides an easy mechanism to cross-reference patterns, by title, using the pattern shortcode. For example, I can reference the Notes & warnings pattern. Here’s what the markdown looks like, including the shortcode: + Cross-references Infusion provides an easy mechanism to cross-reference patterns, by title, using the pattern shortcode. For example, I can reference the Notes & warnings pattern. Here’s what the markdown looks like, including the shortcode: I can reference the {{% pattern "Notes & warnings" %}} 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. @@ -208,7 +208,7 @@ I can reference the {{% pattern "Notes & warnings" %}} patt Mon, 01 Jan 0001 00:00:00 +0000 https://heydon.github.io/infusion/patterns/writing/tables-of-contents/ - Pattern pages in Infusion that have two or more subheadings — <h2>s — automatically get a table of contents: a list of links to the main subsections for the page. This feature is made accessible as a navigation region with the “Table of contents” label and uses an ordered list. The table of contents markup for the Library setup page looks something like this: + Pattern pages in Infusion that have two or more subheadings — <h2>s — automatically get a table of contents: a list of links to the main subsections for the page. This feature is made accessible as a navigation region with the “Table of contents” label and uses an ordered list. The table of contents markup for the Library setup page looks something like this: <nav class="toc" aria-labelledby="toc-heading"> <h2 id="toc-heading">Table of contents</h2> <ol> <li> <a href="#cleaning-the-content-folder">“Cleaning” the content folder</a> </li> <li> <a href="#the-setup-command">The setup command</a> </li> <li> <a href="#the-config-file">The config file</a> </li> <li> <a href="#including-a-logo">Including a logo</a> </li> </ol> </nav> Tables of contents are a neat way to break down the content of the page and give users a navigable overview. diff --git a/docs/js/dom-scripts.js b/docs/js/dom-scripts.js index f960597..84a2f8f 100644 --- a/docs/js/dom-scripts.js +++ b/docs/js/dom-scripts.js @@ -69,7 +69,7 @@ var link = document.createElement('a') link.setAttribute('href', '#' + id) link.setAttribute('aria-label', 'link for this section') - link.innerHTML = '' + link.innerHTML = ' ' container.appendChild(link) diff --git a/docs/patterns/coding/code-blocks/index.html b/docs/patterns/coding/code-blocks/index.html index c64fd39..0b1b2e5 100644 --- a/docs/patterns/coding/code-blocks/index.html +++ b/docs/patterns/coding/code-blocks/index.html @@ -136,7 +136,7 @@ - + Menu @@ -147,28 +147,36 @@ - + + + Installation - + + + Library setup - + + + Serving - + + + Printing @@ -180,42 +188,54 @@ - + + + Library structure - + + + Markdown & metadata - + + + Expandable sections - + + + Notes & warnings - + + + References - + + + Tables of contents @@ -229,14 +249,18 @@ - + + + Including images - + + + Including videos @@ -250,49 +274,63 @@ - + + + Code blocks - + + + Demo embedding - + + + Writing inline demos - + + + Color palettes - + + + Command line - + + + File trees - + + + Tested using... @@ -311,7 +349,9 @@ - + + + Code blocks diff --git a/docs/patterns/coding/color-palettes/index.html b/docs/patterns/coding/color-palettes/index.html index f81b429..8bae492 100644 --- a/docs/patterns/coding/color-palettes/index.html +++ b/docs/patterns/coding/color-palettes/index.html @@ -136,7 +136,7 @@ - + Menu @@ -147,28 +147,36 @@ - + + + Installation - + + + Library setup - + + + Serving - + + + Printing @@ -180,42 +188,54 @@ - + + + Library structure - + + + Markdown & metadata - + + + Expandable sections - + + + Notes & warnings - + + + References - + + + Tables of contents @@ -229,14 +249,18 @@ - + + + Including images - + + + Including videos @@ -250,49 +274,63 @@ - + + + Code blocks - + + + Demo embedding - + + + Writing inline demos - + + + Color palettes - + + + Command line - + + + File trees - + + + Tested using... @@ -311,7 +349,9 @@ - + + + Color palettes @@ -352,7 +392,7 @@
To get started, take a look at Installation.