From ab463449cf32f7007edf4edc7a9fb8c703adf8ea Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 24 May 2021 17:22:39 +0200 Subject: [PATCH 01/23] feat(docs): added sitemap generating file --- packages/docs/src/sitemap.njk | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 packages/docs/src/sitemap.njk diff --git a/packages/docs/src/sitemap.njk b/packages/docs/src/sitemap.njk new file mode 100644 index 000000000..c912abda4 --- /dev/null +++ b/packages/docs/src/sitemap.njk @@ -0,0 +1,15 @@ +--- +eleventyExcludeFromCollections: true +permalink: /sitemap.xml +--- + + +{% for item in collections.all %} + + {{ site.url }}{{ item.url }} + {{ item.date | w3DateFilter()}} + {{ item.data.sitemapChangefreq | default("yearly") }} + {{ item.data.sitemapPriority | default(0.7) }} + +{% endfor %} + \ No newline at end of file From facbbdb0aa35abbe11a24c9ee3bd4b17506af8ee Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 24 May 2021 17:23:08 +0200 Subject: [PATCH 02/23] feat(docs): added robots.txt generating file --- packages/docs/src/robots.njk | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 packages/docs/src/robots.njk diff --git a/packages/docs/src/robots.njk b/packages/docs/src/robots.njk new file mode 100644 index 000000000..efb8b84f1 --- /dev/null +++ b/packages/docs/src/robots.njk @@ -0,0 +1,7 @@ +--- +eleventyExcludeFromCollections: true +permalink: /robots.txt +--- +User-agent: * +Allow: / +Sitemap: {{ site.url }}/sitemap.xml \ No newline at end of file From 0e930cdf38633c7cbf83098a0c02609b9dd6c6a1 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 24 May 2021 17:25:59 +0200 Subject: [PATCH 03/23] feat(docs): added some sitemap generation metadata especially on change frequency, priority and files to ignore from sitemap --- packages/docs/src/admin.njk | 1 + packages/docs/src/archive.md | 1 + packages/docs/src/demos.md | 2 ++ packages/docs/src/docs/a-post-with-code-samples.md | 2 ++ packages/docs/src/docs/advanced-auto-regenerate.md | 1 + packages/docs/src/docs/advanced-config-options.md | 2 ++ packages/docs/src/docs/advanced-ecosystem-overview.md | 1 + packages/docs/src/docs/advanced-exporting-patterns.md | 1 + packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 + packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 + packages/docs/src/docs/advanced-starterkits.md | 1 + .../src/docs/advanced-template-language-and-pattern-engines.md | 1 + packages/docs/src/docs/changes-1-to-2.md | 1 + packages/docs/src/docs/data-json-mustache.md | 1 + packages/docs/src/docs/data-link-variable.md | 1 + packages/docs/src/docs/data-overview.md | 1 + packages/docs/src/docs/data-pattern-specific.md | 1 + packages/docs/src/docs/editing-source-files.md | 2 ++ packages/docs/src/docs/installation.md | 2 ++ packages/docs/src/docs/pattern-add-new.md | 2 ++ packages/docs/src/docs/pattern-adding-annotations.md | 1 + packages/docs/src/docs/pattern-documenting.md | 2 ++ packages/docs/src/docs/pattern-header-footer.md | 2 ++ packages/docs/src/docs/pattern-hiding.md | 2 ++ packages/docs/src/docs/pattern-including.md | 2 ++ packages/docs/src/docs/pattern-linking.md | 1 + packages/docs/src/docs/pattern-managing-assets.md | 2 ++ packages/docs/src/docs/pattern-organization.md | 2 ++ packages/docs/src/docs/pattern-parameters.md | 2 ++ packages/docs/src/docs/pattern-pseudo-patterns.md | 2 ++ packages/docs/src/docs/pattern-reorganizing.md | 2 ++ packages/docs/src/docs/pattern-states.md | 2 ++ packages/docs/src/docs/php-compile.md | 2 ++ packages/docs/src/feed.njk | 1 + packages/docs/src/index.md | 3 +++ packages/docs/src/posts/pattern-lab-website-redesign.md | 1 + packages/docs/src/styleguide.njk | 1 + packages/docs/src/updates.md | 1 + 38 files changed, 57 insertions(+) diff --git a/packages/docs/src/admin.njk b/packages/docs/src/admin.njk index c1c5517d1..84993a16c 100644 --- a/packages/docs/src/admin.njk +++ b/packages/docs/src/admin.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true permalink: '/admin/index.html' --- diff --git a/packages/docs/src/archive.md b/packages/docs/src/archive.md index 76533c10f..e3d74d95a 100644 --- a/packages/docs/src/archive.md +++ b/packages/docs/src/archive.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: 'Posts Archive' layout: 'layouts/archive.njk' --- diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index 441563fc1..d07d9d32f 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,6 +2,8 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started +sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index d5c83f6c7..35827621d 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: DOCS DOCS DOCS tags: - demo-content @@ -7,6 +8,7 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 +sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index da9add972..3c3257988 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,6 +7,7 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 +sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index 19bd1efb3..e3cf4d361 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,6 +7,8 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0c230ec17..0a186250a 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 +sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 0f5d4ff66..57f20c41b 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 +sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2d099c50..e2fddd3c1 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 +sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index 8a69cb693..a27d4bb0b 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 +sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 48ead77e6..87777da66 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 +sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index f59dff6b5..0ad36ebe3 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 +sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/changes-1-to-2.md b/packages/docs/src/docs/changes-1-to-2.md index b167ba607..4cfd21391 100644 --- a/packages/docs/src/docs/changes-1-to-2.md +++ b/packages/docs/src/docs/changes-1-to-2.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: Pattern Lab 1 to Pattern Lab 2 Changes tags: - docs diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index cb8d37ec9..836a22170 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 +sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index fa0fb18c3..6069b7115 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,6 +5,7 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 +sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index 0ce1caf10..c4d0a0a38 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Overview of Data key: data order: 300 +sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index 495053a8f..d2863fa49 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 +sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index 71af3301a..e1cd42fae 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index be1cc19b8..e2082db94 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 +sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bd7d54b9e..bad9986f2 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index 2c535188d..f844a4a92 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 +sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index fd1e8241e..588896e0a 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index 0085347aa..b7f561995 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index 80fe8b20e..aebe671c3 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index fe7f28a69..2b55d9e17 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index fe340d4c4..abab4b087 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 +sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index 5e1e910a6..c7c52c666 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 9e926fdf9..67243d1ba 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index a3640d0d0..5b040e926 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 961e437a3..397cc39bc 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index b2bad3db3..664e9502f 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 65e37d026..3198faf91 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 338e96ddb..9201ebe17 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: php-compile tags: - demo-content @@ -7,6 +8,7 @@ tags: eleventyNavigation: key: php-compile order: 300 +sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/feed.njk b/packages/docs/src/feed.njk index 11c50e48f..d789f41b8 100644 --- a/packages/docs/src/feed.njk +++ b/packages/docs/src/feed.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true permalink: '/feed.xml' --- diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index aaa797e7d..fa80249df 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,4 +1,7 @@ --- layout: home title: Create atomic design systems with Pattern Lab +sitemapChangefreq: 'yearly' +sitemapPriority: '1.0' +sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/posts/pattern-lab-website-redesign.md b/packages/docs/src/posts/pattern-lab-website-redesign.md index 0adfc23ac..47f4de397 100644 --- a/packages/docs/src/posts/pattern-lab-website-redesign.md +++ b/packages/docs/src/posts/pattern-lab-website-redesign.md @@ -5,6 +5,7 @@ date: '2020-02-17' tags: - blog url: '/posts/pattern-lab-website-redesign' +sitemapChangefreq: 'never' --- We're pleased to announce the Pattern Lab website is undergoing a much-needed facelift! diff --git a/packages/docs/src/styleguide.njk b/packages/docs/src/styleguide.njk index 66d64be12..d2cb5cbca 100644 --- a/packages/docs/src/styleguide.njk +++ b/packages/docs/src/styleguide.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: 'Styleguide' permalink: /styleguide/ --- diff --git a/packages/docs/src/updates.md b/packages/docs/src/updates.md index 09a9c2d73..08231fd10 100644 --- a/packages/docs/src/updates.md +++ b/packages/docs/src/updates.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true layout: layouts/blog.njk title: Pattern Lab Updates description: The latest news about the Pattern Lab project From fc76a35fd4055c7fda56adc02fdab53c1aa4af0a Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 24 May 2021 17:26:39 +0200 Subject: [PATCH 04/23] refactor(docs): prevent extra slash at generated URLs --- packages/docs/src/_data/site.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/src/_data/site.json b/packages/docs/src/_data/site.json index 8a5e4ce23..555f61950 100644 --- a/packages/docs/src/_data/site.json +++ b/packages/docs/src/_data/site.json @@ -2,7 +2,7 @@ "showThemeCredit": true, "name": "Pattern Lab", "shortDesc": "Pattern Lab is a frontend workshop environment that helps you build, view, test, and showcase your design system's UI components.", - "url": "https://patternlab.io/", + "url": "https://patternlab.io", "authorEmail": "brad@bradfrost.com", "authorHandle": "@bradfrost", "authorName": "Brad Frost", From 8ae9afd6154f5cc74ca0dd5f9d9be8a75413b2c5 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 24 May 2021 17:40:38 +0200 Subject: [PATCH 05/23] feat(docs): added further sitemap generation metadata --- packages/docs/src/docs/advanced-auto-regenerate.md | 1 + packages/docs/src/resources.md | 1 + packages/docs/src/support.md | 1 + 3 files changed, 3 insertions(+) diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index 3c3257988..c6262f79e 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: Watching for Changes and Auto Regenerating Patterns tags: - docs diff --git a/packages/docs/src/resources.md b/packages/docs/src/resources.md index 9c6681825..5755fe103 100644 --- a/packages/docs/src/resources.md +++ b/packages/docs/src/resources.md @@ -1,6 +1,7 @@ --- layout: layouts/page-base.njk title: Resources +sitemapPriority: '0.8' --- ## Style guides and atomic design diff --git a/packages/docs/src/support.md b/packages/docs/src/support.md index 9a1ee1c4f..9f227fbc0 100644 --- a/packages/docs/src/support.md +++ b/packages/docs/src/support.md @@ -1,6 +1,7 @@ --- layout: layouts/post.njk title: Pattern Lab Support +sitemapPriority: '0.8' --- ## GitHub From 082109101235cc63f53bc29c683bc8b78e378709 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 27 May 2021 21:34:01 +0200 Subject: [PATCH 06/23] Revert "feat(docs): added further sitemap generation metadata" This reverts commit 8ae9afd6154f5cc74ca0dd5f9d9be8a75413b2c5. --- packages/docs/src/docs/advanced-auto-regenerate.md | 1 - packages/docs/src/resources.md | 1 - packages/docs/src/support.md | 1 - 3 files changed, 3 deletions(-) diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index c6262f79e..3c3257988 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: Watching for Changes and Auto Regenerating Patterns tags: - docs diff --git a/packages/docs/src/resources.md b/packages/docs/src/resources.md index 5755fe103..9c6681825 100644 --- a/packages/docs/src/resources.md +++ b/packages/docs/src/resources.md @@ -1,7 +1,6 @@ --- layout: layouts/page-base.njk title: Resources -sitemapPriority: '0.8' --- ## Style guides and atomic design diff --git a/packages/docs/src/support.md b/packages/docs/src/support.md index 9f227fbc0..9a1ee1c4f 100644 --- a/packages/docs/src/support.md +++ b/packages/docs/src/support.md @@ -1,7 +1,6 @@ --- layout: layouts/post.njk title: Pattern Lab Support -sitemapPriority: '0.8' --- ## GitHub From f9ca25c251086b1581971b3bc5ea19fd4fa58e8e Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Fri, 28 May 2021 06:14:30 +0200 Subject: [PATCH 07/23] Revert "refactor(docs): prevent extra slash at generated URLs" This reverts commit fc76a35fd4055c7fda56adc02fdab53c1aa4af0a. --- packages/docs/src/_data/site.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/src/_data/site.json b/packages/docs/src/_data/site.json index 555f61950..8a5e4ce23 100644 --- a/packages/docs/src/_data/site.json +++ b/packages/docs/src/_data/site.json @@ -2,7 +2,7 @@ "showThemeCredit": true, "name": "Pattern Lab", "shortDesc": "Pattern Lab is a frontend workshop environment that helps you build, view, test, and showcase your design system's UI components.", - "url": "https://patternlab.io", + "url": "https://patternlab.io/", "authorEmail": "brad@bradfrost.com", "authorHandle": "@bradfrost", "authorName": "Brad Frost", From c4e3c3b66d9a6f806d742ac2082f855c054f1a48 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Fri, 28 May 2021 06:16:39 +0200 Subject: [PATCH 08/23] Revert "feat(docs): added some sitemap generation metadata" This reverts commit 0e930cdf38633c7cbf83098a0c02609b9dd6c6a1. --- packages/docs/src/admin.njk | 1 - packages/docs/src/archive.md | 1 - packages/docs/src/demos.md | 2 -- packages/docs/src/docs/a-post-with-code-samples.md | 2 -- packages/docs/src/docs/advanced-auto-regenerate.md | 1 - packages/docs/src/docs/advanced-config-options.md | 2 -- packages/docs/src/docs/advanced-ecosystem-overview.md | 1 - packages/docs/src/docs/advanced-exporting-patterns.md | 1 - packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 - packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 - packages/docs/src/docs/advanced-starterkits.md | 1 - .../src/docs/advanced-template-language-and-pattern-engines.md | 1 - packages/docs/src/docs/changes-1-to-2.md | 1 - packages/docs/src/docs/data-json-mustache.md | 1 - packages/docs/src/docs/data-link-variable.md | 1 - packages/docs/src/docs/data-overview.md | 1 - packages/docs/src/docs/data-pattern-specific.md | 1 - packages/docs/src/docs/editing-source-files.md | 2 -- packages/docs/src/docs/installation.md | 2 -- packages/docs/src/docs/pattern-add-new.md | 2 -- packages/docs/src/docs/pattern-adding-annotations.md | 1 - packages/docs/src/docs/pattern-documenting.md | 2 -- packages/docs/src/docs/pattern-header-footer.md | 2 -- packages/docs/src/docs/pattern-hiding.md | 2 -- packages/docs/src/docs/pattern-including.md | 2 -- packages/docs/src/docs/pattern-linking.md | 1 - packages/docs/src/docs/pattern-managing-assets.md | 2 -- packages/docs/src/docs/pattern-organization.md | 2 -- packages/docs/src/docs/pattern-parameters.md | 2 -- packages/docs/src/docs/pattern-pseudo-patterns.md | 2 -- packages/docs/src/docs/pattern-reorganizing.md | 2 -- packages/docs/src/docs/pattern-states.md | 2 -- packages/docs/src/docs/php-compile.md | 2 -- packages/docs/src/feed.njk | 1 - packages/docs/src/index.md | 3 --- packages/docs/src/posts/pattern-lab-website-redesign.md | 1 - packages/docs/src/styleguide.njk | 1 - packages/docs/src/updates.md | 1 - 38 files changed, 57 deletions(-) diff --git a/packages/docs/src/admin.njk b/packages/docs/src/admin.njk index 84993a16c..c1c5517d1 100644 --- a/packages/docs/src/admin.njk +++ b/packages/docs/src/admin.njk @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true permalink: '/admin/index.html' --- diff --git a/packages/docs/src/archive.md b/packages/docs/src/archive.md index e3d74d95a..76533c10f 100644 --- a/packages/docs/src/archive.md +++ b/packages/docs/src/archive.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: 'Posts Archive' layout: 'layouts/archive.njk' --- diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index d07d9d32f..441563fc1 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,8 +2,6 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started -sitemapPriority: '0.9' -sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index 35827621d..d5c83f6c7 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: DOCS DOCS DOCS tags: - demo-content @@ -8,7 +7,6 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 -sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index 3c3257988..da9add972 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,7 +7,6 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 -sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index e3cf4d361..19bd1efb3 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,8 +7,6 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0a186250a..0c230ec17 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,7 +7,6 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 -sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 57f20c41b..0f5d4ff66 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 -sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2fddd3c1..e2d099c50 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 -sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index a27d4bb0b..8a69cb693 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 -sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 87777da66..48ead77e6 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 -sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index 0ad36ebe3..f59dff6b5 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 -sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/changes-1-to-2.md b/packages/docs/src/docs/changes-1-to-2.md index 4cfd21391..b167ba607 100644 --- a/packages/docs/src/docs/changes-1-to-2.md +++ b/packages/docs/src/docs/changes-1-to-2.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: Pattern Lab 1 to Pattern Lab 2 Changes tags: - docs diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index 836a22170..cb8d37ec9 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 -sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index 6069b7115..fa0fb18c3 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,7 +5,6 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 -sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index c4d0a0a38..0ce1caf10 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Overview of Data key: data order: 300 -sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index d2863fa49..495053a8f 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 -sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index e1cd42fae..71af3301a 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index e2082db94..be1cc19b8 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 -sitemapPriority: '0.9' -sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bad9986f2..bd7d54b9e 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index f844a4a92..2c535188d 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 -sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index 588896e0a..fd1e8241e 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index b7f561995..0085347aa 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index aebe671c3..80fe8b20e 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index 2b55d9e17..fe7f28a69 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index abab4b087..fe340d4c4 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 -sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index c7c52c666..5e1e910a6 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 67243d1ba..9e926fdf9 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index 5b040e926..a3640d0d0 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 397cc39bc..961e437a3 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index 664e9502f..b2bad3db3 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 3198faf91..65e37d026 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 9201ebe17..338e96ddb 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: php-compile tags: - demo-content @@ -8,7 +7,6 @@ tags: eleventyNavigation: key: php-compile order: 300 -sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/feed.njk b/packages/docs/src/feed.njk index d789f41b8..11c50e48f 100644 --- a/packages/docs/src/feed.njk +++ b/packages/docs/src/feed.njk @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true permalink: '/feed.xml' --- diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index fa80249df..aaa797e7d 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,7 +1,4 @@ --- layout: home title: Create atomic design systems with Pattern Lab -sitemapChangefreq: 'yearly' -sitemapPriority: '1.0' -sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/posts/pattern-lab-website-redesign.md b/packages/docs/src/posts/pattern-lab-website-redesign.md index 47f4de397..0adfc23ac 100644 --- a/packages/docs/src/posts/pattern-lab-website-redesign.md +++ b/packages/docs/src/posts/pattern-lab-website-redesign.md @@ -5,7 +5,6 @@ date: '2020-02-17' tags: - blog url: '/posts/pattern-lab-website-redesign' -sitemapChangefreq: 'never' --- We're pleased to announce the Pattern Lab website is undergoing a much-needed facelift! diff --git a/packages/docs/src/styleguide.njk b/packages/docs/src/styleguide.njk index d2cb5cbca..66d64be12 100644 --- a/packages/docs/src/styleguide.njk +++ b/packages/docs/src/styleguide.njk @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: 'Styleguide' permalink: /styleguide/ --- diff --git a/packages/docs/src/updates.md b/packages/docs/src/updates.md index 08231fd10..09a9c2d73 100644 --- a/packages/docs/src/updates.md +++ b/packages/docs/src/updates.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true layout: layouts/blog.njk title: Pattern Lab Updates description: The latest news about the Pattern Lab project From 5ca7826e12764344f10f4ed590aea5677675265b Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:11:11 +0200 Subject: [PATCH 09/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/posts/pattern-lab-website-redesign.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/docs/src/posts/pattern-lab-website-redesign.md b/packages/docs/src/posts/pattern-lab-website-redesign.md index 0adfc23ac..47f4de397 100644 --- a/packages/docs/src/posts/pattern-lab-website-redesign.md +++ b/packages/docs/src/posts/pattern-lab-website-redesign.md @@ -5,6 +5,7 @@ date: '2020-02-17' tags: - blog url: '/posts/pattern-lab-website-redesign' +sitemapChangefreq: 'never' --- We're pleased to announce the Pattern Lab website is undergoing a much-needed facelift! From 839fdd2d7a078b38c19d142127f99452a65843a5 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:25:37 +0200 Subject: [PATCH 10/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/demos.md | 2 ++ packages/docs/src/docs/a-post-with-code-samples.md | 1 + packages/docs/src/docs/advanced-auto-regenerate.md | 1 + packages/docs/src/docs/advanced-config-options.md | 2 ++ packages/docs/src/docs/advanced-ecosystem-overview.md | 1 + packages/docs/src/docs/advanced-exporting-patterns.md | 1 + packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 + packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 + packages/docs/src/docs/advanced-starterkits.md | 1 + .../docs/advanced-template-language-and-pattern-engines.md | 1 + packages/docs/src/docs/data-json-mustache.md | 1 + packages/docs/src/docs/data-link-variable.md | 1 + packages/docs/src/docs/data-overview.md | 1 + packages/docs/src/docs/data-pattern-specific.md | 1 + packages/docs/src/docs/editing-source-files.md | 2 ++ packages/docs/src/docs/installation.md | 2 ++ packages/docs/src/docs/pattern-add-new.md | 2 ++ packages/docs/src/docs/pattern-adding-annotations.md | 1 + packages/docs/src/docs/pattern-documenting.md | 2 ++ packages/docs/src/docs/pattern-header-footer.md | 2 ++ packages/docs/src/docs/pattern-hiding.md | 6 ++++-- packages/docs/src/docs/pattern-including.md | 2 ++ packages/docs/src/docs/pattern-linking.md | 1 + packages/docs/src/docs/pattern-managing-assets.md | 2 ++ packages/docs/src/docs/pattern-organization.md | 4 +++- packages/docs/src/docs/pattern-parameters.md | 2 ++ packages/docs/src/docs/pattern-pseudo-patterns.md | 2 ++ packages/docs/src/docs/pattern-reorganizing.md | 6 ++++-- packages/docs/src/docs/pattern-states.md | 2 ++ packages/docs/src/docs/php-compile.md | 1 + packages/docs/src/index.md | 3 +++ 31 files changed, 53 insertions(+), 5 deletions(-) diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index 441563fc1..d07d9d32f 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,6 +2,8 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started +sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index d5c83f6c7..156a0d13c 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -7,6 +7,7 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 +sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index da9add972..3c3257988 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,6 +7,7 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 +sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index 19bd1efb3..e3cf4d361 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,6 +7,8 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0c230ec17..0a186250a 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 +sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 0f5d4ff66..57f20c41b 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 +sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2d099c50..e2fddd3c1 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 +sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index 8a69cb693..a27d4bb0b 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 +sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 48ead77e6..87777da66 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 +sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index f59dff6b5..0ad36ebe3 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 +sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index cb8d37ec9..836a22170 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 +sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index fa0fb18c3..6069b7115 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,6 +5,7 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 +sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index 0ce1caf10..c4d0a0a38 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Overview of Data key: data order: 300 +sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index 495053a8f..d2863fa49 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 +sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index 71af3301a..e1cd42fae 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index be1cc19b8..e2082db94 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 +sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bd7d54b9e..bad9986f2 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index 2c535188d..f844a4a92 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 +sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index fd1e8241e..588896e0a 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index 0085347aa..b7f561995 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index 80fe8b20e..e511bed4f 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: @@ -50,10 +52,10 @@ A hidden pattern can still be included in other patterns. ## Deactivate deprecation warning -To deactivate the deprecation warning for hidden patterns, add +To deactivate the deprecation warning for hidden patterns, add ``` disableDeprecationWarningForHiddenPatterns: true ``` -to the `patternlab-config.json` \ No newline at end of file +to the `patternlab-config.json` diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index fe7f28a69..2b55d9e17 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index fe340d4c4..abab4b087 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 +sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index 5e1e910a6..c7c52c666 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 9e926fdf9..9119fac98 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). @@ -60,4 +62,4 @@ The `deeplyNested` attribute is used to toggle the pattern building behavior and - **deeplyNested not set or false** - Pattern won't be handled as a deeply nested pattern - **deeplyNested: true** - Pattern will be handled like mentioned under [Deeper Nesting](#heading-deeper-nesting) -To turn on this behavior globally, just add `"allPatternsAreDeeplyNested": true` to your `patternlab-config.json`. \ No newline at end of file +To turn on this behavior globally, just add `"allPatternsAreDeeplyNested": true` to your `patternlab-config.json`. diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index a3640d0d0..5b040e926 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 961e437a3..397cc39bc 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index b2bad3db3..1d2b80242 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. @@ -109,10 +111,10 @@ order: 1 ## Deactivate deprecation warning -To deactivate the deprecation warning for ordering patterns, add +To deactivate the deprecation warning for ordering patterns, add ``` disableDeprecationWarningForOrderPatterns: true ``` -to the `patternlab-config.json` \ No newline at end of file +to the `patternlab-config.json` diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 65e37d026..3198faf91 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 338e96ddb..54c4e7a7e 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -7,6 +7,7 @@ tags: eleventyNavigation: key: php-compile order: 300 +sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index aaa797e7d..fa80249df 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,4 +1,7 @@ --- layout: home title: Create atomic design systems with Pattern Lab +sitemapChangefreq: 'yearly' +sitemapPriority: '1.0' +sitemapChangefreq: 'monthly' --- From 17b78740aceb541086bd119c15055f9796a75a34 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:34:11 +0200 Subject: [PATCH 11/23] Revert "feat(docs): added some sitemap generation metadata" This reverts commit 839fdd2d7a078b38c19d142127f99452a65843a5. --- packages/docs/src/demos.md | 2 -- packages/docs/src/docs/a-post-with-code-samples.md | 1 - packages/docs/src/docs/advanced-auto-regenerate.md | 1 - packages/docs/src/docs/advanced-config-options.md | 2 -- packages/docs/src/docs/advanced-ecosystem-overview.md | 1 - packages/docs/src/docs/advanced-exporting-patterns.md | 1 - packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 - packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 - packages/docs/src/docs/advanced-starterkits.md | 1 - .../docs/advanced-template-language-and-pattern-engines.md | 1 - packages/docs/src/docs/data-json-mustache.md | 1 - packages/docs/src/docs/data-link-variable.md | 1 - packages/docs/src/docs/data-overview.md | 1 - packages/docs/src/docs/data-pattern-specific.md | 1 - packages/docs/src/docs/editing-source-files.md | 2 -- packages/docs/src/docs/installation.md | 2 -- packages/docs/src/docs/pattern-add-new.md | 2 -- packages/docs/src/docs/pattern-adding-annotations.md | 1 - packages/docs/src/docs/pattern-documenting.md | 2 -- packages/docs/src/docs/pattern-header-footer.md | 2 -- packages/docs/src/docs/pattern-hiding.md | 6 ++---- packages/docs/src/docs/pattern-including.md | 2 -- packages/docs/src/docs/pattern-linking.md | 1 - packages/docs/src/docs/pattern-managing-assets.md | 2 -- packages/docs/src/docs/pattern-organization.md | 4 +--- packages/docs/src/docs/pattern-parameters.md | 2 -- packages/docs/src/docs/pattern-pseudo-patterns.md | 2 -- packages/docs/src/docs/pattern-reorganizing.md | 6 ++---- packages/docs/src/docs/pattern-states.md | 2 -- packages/docs/src/docs/php-compile.md | 1 - packages/docs/src/index.md | 3 --- 31 files changed, 5 insertions(+), 53 deletions(-) diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index d07d9d32f..441563fc1 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,8 +2,6 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started -sitemapPriority: '0.9' -sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index 156a0d13c..d5c83f6c7 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -7,7 +7,6 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 -sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index 3c3257988..da9add972 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,7 +7,6 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 -sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index e3cf4d361..19bd1efb3 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,8 +7,6 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0a186250a..0c230ec17 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,7 +7,6 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 -sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 57f20c41b..0f5d4ff66 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 -sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2fddd3c1..e2d099c50 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 -sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index a27d4bb0b..8a69cb693 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 -sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 87777da66..48ead77e6 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 -sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index 0ad36ebe3..f59dff6b5 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 -sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index 836a22170..cb8d37ec9 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 -sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index 6069b7115..fa0fb18c3 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,7 +5,6 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 -sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index c4d0a0a38..0ce1caf10 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Overview of Data key: data order: 300 -sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index d2863fa49..495053a8f 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 -sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index e1cd42fae..71af3301a 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index e2082db94..be1cc19b8 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 -sitemapPriority: '0.9' -sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bad9986f2..bd7d54b9e 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index f844a4a92..2c535188d 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 -sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index 588896e0a..fd1e8241e 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index b7f561995..0085347aa 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index e511bed4f..80fe8b20e 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: @@ -52,10 +50,10 @@ A hidden pattern can still be included in other patterns. ## Deactivate deprecation warning -To deactivate the deprecation warning for hidden patterns, add +To deactivate the deprecation warning for hidden patterns, add ``` disableDeprecationWarningForHiddenPatterns: true ``` -to the `patternlab-config.json` +to the `patternlab-config.json` \ No newline at end of file diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index 2b55d9e17..fe7f28a69 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index abab4b087..fe340d4c4 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 -sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index c7c52c666..5e1e910a6 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 9119fac98..9e926fdf9 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). @@ -62,4 +60,4 @@ The `deeplyNested` attribute is used to toggle the pattern building behavior and - **deeplyNested not set or false** - Pattern won't be handled as a deeply nested pattern - **deeplyNested: true** - Pattern will be handled like mentioned under [Deeper Nesting](#heading-deeper-nesting) -To turn on this behavior globally, just add `"allPatternsAreDeeplyNested": true` to your `patternlab-config.json`. +To turn on this behavior globally, just add `"allPatternsAreDeeplyNested": true` to your `patternlab-config.json`. \ No newline at end of file diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index 5b040e926..a3640d0d0 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 397cc39bc..961e437a3 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index 1d2b80242..b2bad3db3 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. @@ -111,10 +109,10 @@ order: 1 ## Deactivate deprecation warning -To deactivate the deprecation warning for ordering patterns, add +To deactivate the deprecation warning for ordering patterns, add ``` disableDeprecationWarningForOrderPatterns: true ``` -to the `patternlab-config.json` +to the `patternlab-config.json` \ No newline at end of file diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 3198faf91..65e37d026 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 54c4e7a7e..338e96ddb 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -7,7 +7,6 @@ tags: eleventyNavigation: key: php-compile order: 300 -sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index fa80249df..aaa797e7d 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,7 +1,4 @@ --- layout: home title: Create atomic design systems with Pattern Lab -sitemapChangefreq: 'yearly' -sitemapPriority: '1.0' -sitemapChangefreq: 'monthly' --- From c61f387c72bb2bcd7dd06e03ba25f88e3ba063c8 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:34:27 +0200 Subject: [PATCH 12/23] Revert "Revert "feat(docs): added some sitemap generation metadata"" This reverts commit c4e3c3b66d9a6f806d742ac2082f855c054f1a48. --- packages/docs/src/admin.njk | 1 + packages/docs/src/archive.md | 1 + packages/docs/src/demos.md | 2 ++ packages/docs/src/docs/a-post-with-code-samples.md | 2 ++ packages/docs/src/docs/advanced-auto-regenerate.md | 1 + packages/docs/src/docs/advanced-config-options.md | 2 ++ packages/docs/src/docs/advanced-ecosystem-overview.md | 1 + packages/docs/src/docs/advanced-exporting-patterns.md | 1 + packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 + packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 + packages/docs/src/docs/advanced-starterkits.md | 1 + .../src/docs/advanced-template-language-and-pattern-engines.md | 1 + packages/docs/src/docs/changes-1-to-2.md | 1 + packages/docs/src/docs/data-json-mustache.md | 1 + packages/docs/src/docs/data-link-variable.md | 1 + packages/docs/src/docs/data-overview.md | 1 + packages/docs/src/docs/data-pattern-specific.md | 1 + packages/docs/src/docs/editing-source-files.md | 2 ++ packages/docs/src/docs/installation.md | 2 ++ packages/docs/src/docs/pattern-add-new.md | 2 ++ packages/docs/src/docs/pattern-adding-annotations.md | 1 + packages/docs/src/docs/pattern-documenting.md | 2 ++ packages/docs/src/docs/pattern-header-footer.md | 2 ++ packages/docs/src/docs/pattern-hiding.md | 2 ++ packages/docs/src/docs/pattern-including.md | 2 ++ packages/docs/src/docs/pattern-linking.md | 1 + packages/docs/src/docs/pattern-managing-assets.md | 2 ++ packages/docs/src/docs/pattern-organization.md | 2 ++ packages/docs/src/docs/pattern-parameters.md | 2 ++ packages/docs/src/docs/pattern-pseudo-patterns.md | 2 ++ packages/docs/src/docs/pattern-reorganizing.md | 2 ++ packages/docs/src/docs/pattern-states.md | 2 ++ packages/docs/src/docs/php-compile.md | 2 ++ packages/docs/src/feed.njk | 1 + packages/docs/src/index.md | 3 +++ packages/docs/src/styleguide.njk | 1 + packages/docs/src/updates.md | 1 + 37 files changed, 56 insertions(+) diff --git a/packages/docs/src/admin.njk b/packages/docs/src/admin.njk index c1c5517d1..84993a16c 100644 --- a/packages/docs/src/admin.njk +++ b/packages/docs/src/admin.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true permalink: '/admin/index.html' --- diff --git a/packages/docs/src/archive.md b/packages/docs/src/archive.md index 76533c10f..e3d74d95a 100644 --- a/packages/docs/src/archive.md +++ b/packages/docs/src/archive.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: 'Posts Archive' layout: 'layouts/archive.njk' --- diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index 441563fc1..d07d9d32f 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,6 +2,8 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started +sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index d5c83f6c7..35827621d 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: DOCS DOCS DOCS tags: - demo-content @@ -7,6 +8,7 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 +sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index da9add972..3c3257988 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,6 +7,7 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 +sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index 19bd1efb3..e3cf4d361 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,6 +7,8 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0c230ec17..0a186250a 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 +sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 0f5d4ff66..57f20c41b 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 +sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2d099c50..e2fddd3c1 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 +sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index 8a69cb693..a27d4bb0b 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 +sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 48ead77e6..87777da66 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 +sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index f59dff6b5..0ad36ebe3 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 +sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/changes-1-to-2.md b/packages/docs/src/docs/changes-1-to-2.md index b167ba607..4cfd21391 100644 --- a/packages/docs/src/docs/changes-1-to-2.md +++ b/packages/docs/src/docs/changes-1-to-2.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: Pattern Lab 1 to Pattern Lab 2 Changes tags: - docs diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index cb8d37ec9..836a22170 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 +sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index fa0fb18c3..6069b7115 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,6 +5,7 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 +sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index 0ce1caf10..c4d0a0a38 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Overview of Data key: data order: 300 +sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index 495053a8f..d2863fa49 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 +sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index 71af3301a..e1cd42fae 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index be1cc19b8..e2082db94 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 +sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bd7d54b9e..bad9986f2 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index 2c535188d..f844a4a92 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 +sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index fd1e8241e..588896e0a 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index 0085347aa..b7f561995 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index 80fe8b20e..aebe671c3 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index fe7f28a69..2b55d9e17 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index fe340d4c4..abab4b087 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 +sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index 5e1e910a6..c7c52c666 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 9e926fdf9..67243d1ba 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index a3640d0d0..5b040e926 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 961e437a3..397cc39bc 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index b2bad3db3..664e9502f 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 65e37d026..3198faf91 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,6 +7,8 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 +sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 338e96ddb..9201ebe17 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: php-compile tags: - demo-content @@ -7,6 +8,7 @@ tags: eleventyNavigation: key: php-compile order: 300 +sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/feed.njk b/packages/docs/src/feed.njk index 11c50e48f..d789f41b8 100644 --- a/packages/docs/src/feed.njk +++ b/packages/docs/src/feed.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true permalink: '/feed.xml' --- diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index aaa797e7d..fa80249df 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,4 +1,7 @@ --- layout: home title: Create atomic design systems with Pattern Lab +sitemapChangefreq: 'yearly' +sitemapPriority: '1.0' +sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/styleguide.njk b/packages/docs/src/styleguide.njk index 66d64be12..d2cb5cbca 100644 --- a/packages/docs/src/styleguide.njk +++ b/packages/docs/src/styleguide.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: 'Styleguide' permalink: /styleguide/ --- diff --git a/packages/docs/src/updates.md b/packages/docs/src/updates.md index 09a9c2d73..08231fd10 100644 --- a/packages/docs/src/updates.md +++ b/packages/docs/src/updates.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true layout: layouts/blog.njk title: Pattern Lab Updates description: The latest news about the Pattern Lab project From 0fc88b5f3a7d8aa34f7cf444432d1420a3613bc1 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:34:38 +0200 Subject: [PATCH 13/23] Revert "Revert "Revert "feat(docs): added some sitemap generation metadata""" This reverts commit c61f387c72bb2bcd7dd06e03ba25f88e3ba063c8. --- packages/docs/src/admin.njk | 1 - packages/docs/src/archive.md | 1 - packages/docs/src/demos.md | 2 -- packages/docs/src/docs/a-post-with-code-samples.md | 2 -- packages/docs/src/docs/advanced-auto-regenerate.md | 1 - packages/docs/src/docs/advanced-config-options.md | 2 -- packages/docs/src/docs/advanced-ecosystem-overview.md | 1 - packages/docs/src/docs/advanced-exporting-patterns.md | 1 - packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 - packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 - packages/docs/src/docs/advanced-starterkits.md | 1 - .../src/docs/advanced-template-language-and-pattern-engines.md | 1 - packages/docs/src/docs/changes-1-to-2.md | 1 - packages/docs/src/docs/data-json-mustache.md | 1 - packages/docs/src/docs/data-link-variable.md | 1 - packages/docs/src/docs/data-overview.md | 1 - packages/docs/src/docs/data-pattern-specific.md | 1 - packages/docs/src/docs/editing-source-files.md | 2 -- packages/docs/src/docs/installation.md | 2 -- packages/docs/src/docs/pattern-add-new.md | 2 -- packages/docs/src/docs/pattern-adding-annotations.md | 1 - packages/docs/src/docs/pattern-documenting.md | 2 -- packages/docs/src/docs/pattern-header-footer.md | 2 -- packages/docs/src/docs/pattern-hiding.md | 2 -- packages/docs/src/docs/pattern-including.md | 2 -- packages/docs/src/docs/pattern-linking.md | 1 - packages/docs/src/docs/pattern-managing-assets.md | 2 -- packages/docs/src/docs/pattern-organization.md | 2 -- packages/docs/src/docs/pattern-parameters.md | 2 -- packages/docs/src/docs/pattern-pseudo-patterns.md | 2 -- packages/docs/src/docs/pattern-reorganizing.md | 2 -- packages/docs/src/docs/pattern-states.md | 2 -- packages/docs/src/docs/php-compile.md | 2 -- packages/docs/src/feed.njk | 1 - packages/docs/src/index.md | 3 --- packages/docs/src/styleguide.njk | 1 - packages/docs/src/updates.md | 1 - 37 files changed, 56 deletions(-) diff --git a/packages/docs/src/admin.njk b/packages/docs/src/admin.njk index 84993a16c..c1c5517d1 100644 --- a/packages/docs/src/admin.njk +++ b/packages/docs/src/admin.njk @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true permalink: '/admin/index.html' --- diff --git a/packages/docs/src/archive.md b/packages/docs/src/archive.md index e3d74d95a..76533c10f 100644 --- a/packages/docs/src/archive.md +++ b/packages/docs/src/archive.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: 'Posts Archive' layout: 'layouts/archive.njk' --- diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index d07d9d32f..441563fc1 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,8 +2,6 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started -sitemapPriority: '0.9' -sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index 35827621d..d5c83f6c7 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: DOCS DOCS DOCS tags: - demo-content @@ -8,7 +7,6 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 -sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index 3c3257988..da9add972 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,7 +7,6 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 -sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index e3cf4d361..19bd1efb3 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,8 +7,6 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0a186250a..0c230ec17 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,7 +7,6 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 -sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 57f20c41b..0f5d4ff66 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 -sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2fddd3c1..e2d099c50 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 -sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index a27d4bb0b..8a69cb693 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 -sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 87777da66..48ead77e6 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 -sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index 0ad36ebe3..f59dff6b5 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 -sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/changes-1-to-2.md b/packages/docs/src/docs/changes-1-to-2.md index 4cfd21391..b167ba607 100644 --- a/packages/docs/src/docs/changes-1-to-2.md +++ b/packages/docs/src/docs/changes-1-to-2.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: Pattern Lab 1 to Pattern Lab 2 Changes tags: - docs diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index 836a22170..cb8d37ec9 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 -sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index 6069b7115..fa0fb18c3 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,7 +5,6 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 -sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index c4d0a0a38..0ce1caf10 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Overview of Data key: data order: 300 -sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index d2863fa49..495053a8f 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 -sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index e1cd42fae..71af3301a 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index e2082db94..be1cc19b8 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 -sitemapPriority: '0.9' -sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bad9986f2..bd7d54b9e 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index f844a4a92..2c535188d 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 -sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index 588896e0a..fd1e8241e 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index b7f561995..0085347aa 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index aebe671c3..80fe8b20e 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index 2b55d9e17..fe7f28a69 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index abab4b087..fe340d4c4 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,7 +7,6 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 -sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index c7c52c666..5e1e910a6 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 67243d1ba..9e926fdf9 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index 5b040e926..a3640d0d0 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 397cc39bc..961e437a3 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index 664e9502f..b2bad3db3 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 3198faf91..65e37d026 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,8 +7,6 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 -sitemapPriority: '0.8' -sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 9201ebe17..338e96ddb 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: php-compile tags: - demo-content @@ -8,7 +7,6 @@ tags: eleventyNavigation: key: php-compile order: 300 -sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/feed.njk b/packages/docs/src/feed.njk index d789f41b8..11c50e48f 100644 --- a/packages/docs/src/feed.njk +++ b/packages/docs/src/feed.njk @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true permalink: '/feed.xml' --- diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index fa80249df..aaa797e7d 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,7 +1,4 @@ --- layout: home title: Create atomic design systems with Pattern Lab -sitemapChangefreq: 'yearly' -sitemapPriority: '1.0' -sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/styleguide.njk b/packages/docs/src/styleguide.njk index d2cb5cbca..66d64be12 100644 --- a/packages/docs/src/styleguide.njk +++ b/packages/docs/src/styleguide.njk @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: 'Styleguide' permalink: /styleguide/ --- diff --git a/packages/docs/src/updates.md b/packages/docs/src/updates.md index 08231fd10..09a9c2d73 100644 --- a/packages/docs/src/updates.md +++ b/packages/docs/src/updates.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true layout: layouts/blog.njk title: Pattern Lab Updates description: The latest news about the Pattern Lab project From 92a593272e8de696644a7365428b58d1a2fc4fdc Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:35:15 +0200 Subject: [PATCH 14/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/docs/a-post-with-code-samples.md | 1 + packages/docs/src/docs/advanced-auto-regenerate.md | 1 + 2 files changed, 2 insertions(+) diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index d5c83f6c7..156a0d13c 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -7,6 +7,7 @@ tags: eleventyNavigation: key: DOCS DOCS DOCS order: 300 +sitemapPriority: '0.8' --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index da9add972..3c3257988 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -7,6 +7,7 @@ eleventyNavigation: key: Watching for Changes and Auto Regenerating Patterns parent: advanced order: 300 +sitemapPriority: '0.8' --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. From 860dce08fcda99ab34d933513f23fff2bf15cbd3 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 18:47:50 +0200 Subject: [PATCH 15/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/docs/advanced-ecosystem-overview.md | 1 + packages/docs/src/docs/advanced-exporting-patterns.md | 1 + packages/docs/src/docs/advanced-keyboard-shortcuts.md | 1 + packages/docs/src/docs/advanced-pattern-lab-nav.md | 1 + packages/docs/src/docs/advanced-starterkits.md | 1 + .../src/docs/advanced-template-language-and-pattern-engines.md | 1 + packages/docs/src/docs/data-json-mustache.md | 1 + packages/docs/src/docs/data-link-variable.md | 1 + packages/docs/src/docs/data-overview.md | 1 + packages/docs/src/docs/data-pattern-specific.md | 1 + packages/docs/src/docs/pattern-adding-annotations.md | 1 + packages/docs/src/docs/pattern-linking.md | 1 + packages/docs/src/docs/php-compile.md | 1 + 13 files changed, 13 insertions(+) diff --git a/packages/docs/src/docs/advanced-ecosystem-overview.md b/packages/docs/src/docs/advanced-ecosystem-overview.md index 0c230ec17..0a186250a 100644 --- a/packages/docs/src/docs/advanced-ecosystem-overview.md +++ b/packages/docs/src/docs/advanced-ecosystem-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: key: advanced title: Overview of Pattern Lab's Ecosystem order: 300 +sitemapPriority: '0.8' --- Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Documentation that explains how best to take advantage of the ecosystem will be released in the coming weeks. diff --git a/packages/docs/src/docs/advanced-exporting-patterns.md b/packages/docs/src/docs/advanced-exporting-patterns.md index 0f5d4ff66..57f20c41b 100644 --- a/packages/docs/src/docs/advanced-exporting-patterns.md +++ b/packages/docs/src/docs/advanced-exporting-patterns.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Exporting Patterns key: advanced order: 300 +sitemapPriority: '0.8' --- While the Pattern Lab website is great for design, iteration, alignment, and discussion - you may find yourself wanting to export whole pattern markup snippets into a different environment. diff --git a/packages/docs/src/docs/advanced-keyboard-shortcuts.md b/packages/docs/src/docs/advanced-keyboard-shortcuts.md index e2d099c50..e2fddd3c1 100644 --- a/packages/docs/src/docs/advanced-keyboard-shortcuts.md +++ b/packages/docs/src/docs/advanced-keyboard-shortcuts.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Keyboard Shortcuts key: advanced order: 300 +sitemapPriority: '0.8' --- > **Note:** This feature is currently disabled. It will be back in a future release of `styleguidekit-assets-default`. diff --git a/packages/docs/src/docs/advanced-pattern-lab-nav.md b/packages/docs/src/docs/advanced-pattern-lab-nav.md index 8a69cb693..a27d4bb0b 100644 --- a/packages/docs/src/docs/advanced-pattern-lab-nav.md +++ b/packages/docs/src/docs/advanced-pattern-lab-nav.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Modifying Pattern Lab's Navigation key: advanced order: 300 +sitemapPriority: '0.8' --- When sharing Pattern Lab with a client it may be beneficial to turn-off certain elements in the default navigation. To turn-off navigation elements, alter the flags inside the `ishControlsHide` object within `patternlab-config.json` and then re-generate the site. The following keys are supported and will hide their respective elements if toggled on: diff --git a/packages/docs/src/docs/advanced-starterkits.md b/packages/docs/src/docs/advanced-starterkits.md index 48ead77e6..87777da66 100644 --- a/packages/docs/src/docs/advanced-starterkits.md +++ b/packages/docs/src/docs/advanced-starterkits.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Starterkits key: advanced order: 300 +sitemapPriority: '0.8' --- Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design. diff --git a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md index f59dff6b5..0ad36ebe3 100644 --- a/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md +++ b/packages/docs/src/docs/advanced-template-language-and-pattern-engines.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Template Language and PatternEngines key: advanced order: 300 +sitemapPriority: '0.8' --- By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats. diff --git a/packages/docs/src/docs/data-json-mustache.md b/packages/docs/src/docs/data-json-mustache.md index cb8d37ec9..836a22170 100644 --- a/packages/docs/src/docs/data-json-mustache.md +++ b/packages/docs/src/docs/data-json-mustache.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Introduction to JSON & Mustache Variables key: data order: 300 +sitemapPriority: '0.8' --- > This documentation is provided as a simple introduction to using one of the supported data types and one of the supported PatternEngines. The best reference for this topic is the [Mustache documentation](http://mustache.github.io/mustache.5.html) but this should provide a good beginner's primer. diff --git a/packages/docs/src/docs/data-link-variable.md b/packages/docs/src/docs/data-link-variable.md index fa0fb18c3..6069b7115 100644 --- a/packages/docs/src/docs/data-link-variable.md +++ b/packages/docs/src/docs/data-link-variable.md @@ -5,6 +5,7 @@ eleventyNavigation: title: Linking to Patterns with Pattern Lab's Default `link` Variable key: data order: 100 +sitemapPriority: '0.8' --- You can build patterns that link to one another to help simulate using a real website. This is especially useful when working with the Pages and Templates pattern types. Rather than having to remember the actual path to a pattern you can use the same shorthand syntax you'd use to include one pattern within another. **Important:** Pattern links _do not_ support the same fuzzy matching of names as the shorthand partials syntax does. The basic format is: diff --git a/packages/docs/src/docs/data-overview.md b/packages/docs/src/docs/data-overview.md index 0ce1caf10..c4d0a0a38 100644 --- a/packages/docs/src/docs/data-overview.md +++ b/packages/docs/src/docs/data-overview.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Overview of Data key: data order: 300 +sitemapPriority: '0.8' --- The primary default global source of data used when rendering Pattern Lab patterns can be found in `./source/_data/`. diff --git a/packages/docs/src/docs/data-pattern-specific.md b/packages/docs/src/docs/data-pattern-specific.md index 495053a8f..d2863fa49 100644 --- a/packages/docs/src/docs/data-pattern-specific.md +++ b/packages/docs/src/docs/data-pattern-specific.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Creating Pattern-specific Values key: data order: 300 +sitemapPriority: '0.8' --- > **Note:** This article uses JSON because it is a standard between with the Node version of Pattern Lab. diff --git a/packages/docs/src/docs/pattern-adding-annotations.md b/packages/docs/src/docs/pattern-adding-annotations.md index 2c535188d..f844a4a92 100644 --- a/packages/docs/src/docs/pattern-adding-annotations.md +++ b/packages/docs/src/docs/pattern-adding-annotations.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Adding Annotations key: patterns order: 180 +sitemapPriority: '0.8' --- Annotations provide an easy way to add notes to elements that may appear inside patterns. Annotations can be saved as a single JSON file at `./source/_annotations/annotations.js` or as multiple Markdown files in `./source/_annotations/`. They're _not_ tied to any specific patterns. When annotations are active they are compared against every pattern using a CSS selector syntax. diff --git a/packages/docs/src/docs/pattern-linking.md b/packages/docs/src/docs/pattern-linking.md index fe340d4c4..abab4b087 100644 --- a/packages/docs/src/docs/pattern-linking.md +++ b/packages/docs/src/docs/pattern-linking.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Pattern Lab's Special Query String Variables key: patterns order: 100 +sitemapPriority: '0.8' --- Pattern Lab comes with support for a number of special query string variables to help you share patterns with clients. These query string variables include ways to link to patterns, set the Pattern Lab viewport to a specific width, open various views as well as start Hay and disco modes on page load. There are lots of options: diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 338e96ddb..54c4e7a7e 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -7,6 +7,7 @@ tags: eleventyNavigation: key: php-compile order: 300 +sitemapChangefreq: 'never' --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. From bb22e74d23764ec0a7a7431a32f88885c9c77967 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 19:02:18 +0200 Subject: [PATCH 16/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/demos.md | 1 + packages/docs/src/docs/advanced-config-options.md | 1 + packages/docs/src/docs/editing-source-files.md | 1 + packages/docs/src/docs/installation.md | 1 + packages/docs/src/docs/pattern-add-new.md | 1 + packages/docs/src/docs/pattern-documenting.md | 1 + packages/docs/src/docs/pattern-header-footer.md | 1 + packages/docs/src/docs/pattern-including.md | 1 + packages/docs/src/docs/pattern-managing-assets.md | 1 + packages/docs/src/docs/pattern-parameters.md | 1 + packages/docs/src/docs/pattern-pseudo-patterns.md | 1 + packages/docs/src/docs/pattern-states.md | 1 + packages/docs/src/index.md | 1 + 13 files changed, 13 insertions(+) diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index 441563fc1..24f536e6e 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -2,6 +2,7 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started +sitemapPriority: '0.9' --- diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index 19bd1efb3..ded2b7622 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -7,6 +7,7 @@ eleventyNavigation: key: getting-started title: Editing the Configuration Options order: 30 +sitemapPriority: '0.8' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index 71af3301a..e6daed664 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Editing Pattern Lab Source Files key: getting-started order: 20 +sitemapPriority: '0.8' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index be1cc19b8..ec7601f96 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Installing Pattern Lab key: getting-started order: 0 +sitemapPriority: '0.9' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index bd7d54b9e..43fc5679a 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Adding New Patterns key: patterns order: 70 +sitemapPriority: '0.8' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index fd1e8241e..2056a1225 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Documenting Patterns key: patterns order: 110 +sitemapPriority: '0.8' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index 0085347aa..8b09db13f 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Modifying the Pattern Header & Footer key: patterns order: 130 +sitemapPriority: '0.8' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index fe7f28a69..05c2247e3 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Including Patterns key: patterns order: 90 +sitemapPriority: '0.8' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index 5e1e910a6..81e955c17 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Managing Pattern Assets key: patterns order: 120 +sitemapPriority: '0.8' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index a3640d0d0..400f1f9e6 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Using Pattern Parameters key: patterns order: 150 +sitemapPriority: '0.8' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 961e437a3..2ee892832 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Using Pseudo-Patterns key: patterns order: 140 +sitemapPriority: '0.8' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 65e37d026..3da67d9e3 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Using Pattern States key: patterns order: 160 +sitemapPriority: '0.8' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index aaa797e7d..5dfd66a1d 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -1,4 +1,5 @@ --- layout: home title: Create atomic design systems with Pattern Lab +sitemapPriority: '1.0' --- From 323c0eeebe80933463dac94b34c034c0c8965462 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 19:10:00 +0200 Subject: [PATCH 17/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/docs/pattern-hiding.md | 5 +++-- packages/docs/src/docs/pattern-organization.md | 3 ++- packages/docs/src/docs/pattern-reorganizing.md | 5 +++-- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index 80fe8b20e..3162cbec6 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Hiding Patterns in the Navigation key: patterns order: 170 +sitemapPriority: '0.8' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: @@ -50,10 +51,10 @@ A hidden pattern can still be included in other patterns. ## Deactivate deprecation warning -To deactivate the deprecation warning for hidden patterns, add +To deactivate the deprecation warning for hidden patterns, add ``` disableDeprecationWarningForHiddenPatterns: true ``` -to the `patternlab-config.json` \ No newline at end of file +to the `patternlab-config.json` diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 9e926fdf9..9b51552da 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Overview of Patterns key: patterns order: 10 +sitemapPriority: '0.8' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). @@ -60,4 +61,4 @@ The `deeplyNested` attribute is used to toggle the pattern building behavior and - **deeplyNested not set or false** - Pattern won't be handled as a deeply nested pattern - **deeplyNested: true** - Pattern will be handled like mentioned under [Deeper Nesting](#heading-deeper-nesting) -To turn on this behavior globally, just add `"allPatternsAreDeeplyNested": true` to your `patternlab-config.json`. \ No newline at end of file +To turn on this behavior globally, just add `"allPatternsAreDeeplyNested": true` to your `patternlab-config.json`. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index b2bad3db3..ea2491dba 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -7,6 +7,7 @@ eleventyNavigation: title: Reorganizing Patterns key: patterns order: 80 +sitemapPriority: '0.8' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. @@ -109,10 +110,10 @@ order: 1 ## Deactivate deprecation warning -To deactivate the deprecation warning for ordering patterns, add +To deactivate the deprecation warning for ordering patterns, add ``` disableDeprecationWarningForOrderPatterns: true ``` -to the `patternlab-config.json` \ No newline at end of file +to the `patternlab-config.json` From fca3abe4e5badddffc5e6310bb3e9020fe055787 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 19:21:43 +0200 Subject: [PATCH 18/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/demos.md | 1 + packages/docs/src/docs/advanced-config-options.md | 1 + packages/docs/src/docs/editing-source-files.md | 1 + packages/docs/src/docs/installation.md | 1 + packages/docs/src/docs/pattern-add-new.md | 1 + packages/docs/src/docs/pattern-documenting.md | 1 + packages/docs/src/docs/pattern-header-footer.md | 1 + packages/docs/src/docs/pattern-hiding.md | 1 + packages/docs/src/docs/pattern-including.md | 1 + packages/docs/src/docs/pattern-managing-assets.md | 1 + packages/docs/src/docs/pattern-organization.md | 1 + packages/docs/src/docs/pattern-parameters.md | 1 + packages/docs/src/docs/pattern-pseudo-patterns.md | 1 + packages/docs/src/docs/pattern-reorganizing.md | 1 + packages/docs/src/docs/pattern-states.md | 1 + packages/docs/src/index.md | 1 + 16 files changed, 16 insertions(+) diff --git a/packages/docs/src/demos.md b/packages/docs/src/demos.md index 24f536e6e..d07d9d32f 100644 --- a/packages/docs/src/demos.md +++ b/packages/docs/src/demos.md @@ -3,6 +3,7 @@ layout: layouts/demos.njk title: Pattern Lab Demos category: getting-started sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- diff --git a/packages/docs/src/docs/advanced-config-options.md b/packages/docs/src/docs/advanced-config-options.md index ded2b7622..e3cf4d361 100644 --- a/packages/docs/src/docs/advanced-config-options.md +++ b/packages/docs/src/docs/advanced-config-options.md @@ -8,6 +8,7 @@ eleventyNavigation: title: Editing the Configuration Options order: 30 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern Lab Node comes with a configuration file [(`patternlab-config.json`)](https://github.com/pattern-lab/patternlab-node/blob/master/packages/core/patternlab-config.json) that allows you to modify certain aspects of the system. The latest default values are included within. This file is shipped within [the editions](https://github.com/pattern-lab?utf8=%E2%9C%93&query=edition-node) or can be supplied from core and the command line interface. Below is a description of each configuration option and how it affects Pattern Lab Node. diff --git a/packages/docs/src/docs/editing-source-files.md b/packages/docs/src/docs/editing-source-files.md index e6daed664..e1cd42fae 100644 --- a/packages/docs/src/docs/editing-source-files.md +++ b/packages/docs/src/docs/editing-source-files.md @@ -8,6 +8,7 @@ eleventyNavigation: key: getting-started order: 20 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory. diff --git a/packages/docs/src/docs/installation.md b/packages/docs/src/docs/installation.md index ec7601f96..e2082db94 100644 --- a/packages/docs/src/docs/installation.md +++ b/packages/docs/src/docs/installation.md @@ -8,6 +8,7 @@ eleventyNavigation: key: getting-started order: 0 sitemapPriority: '0.9' +sitemapChangefreq: 'monthly' --- ## Step 1: Install requirements diff --git a/packages/docs/src/docs/pattern-add-new.md b/packages/docs/src/docs/pattern-add-new.md index 43fc5679a..bad9986f2 100644 --- a/packages/docs/src/docs/pattern-add-new.md +++ b/packages/docs/src/docs/pattern-add-new.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 70 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add new patterns to the Node version of Pattern Lab just add new Mustache templates under the appropriate pattern type or pattern subgroup directories in `./source/_patterns`. For example, let's add a new pattern under the pattern type "molecules" and the pattern sub-type "blocks". The `./source/_patterns/molecules/blocks/` directory looks like: diff --git a/packages/docs/src/docs/pattern-documenting.md b/packages/docs/src/docs/pattern-documenting.md index 2056a1225..588896e0a 100644 --- a/packages/docs/src/docs/pattern-documenting.md +++ b/packages/docs/src/docs/pattern-documenting.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 110 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern documentation gives developers and designers the ability to provide context for their patterns. The documentation file consists of Markdown with YAML front matter. It should follow this format: diff --git a/packages/docs/src/docs/pattern-header-footer.md b/packages/docs/src/docs/pattern-header-footer.md index 8b09db13f..b7f561995 100644 --- a/packages/docs/src/docs/pattern-header-footer.md +++ b/packages/docs/src/docs/pattern-header-footer.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 130 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To add your own assets like JavaScript and CSS to your patterns' header and footer you need to modify two files: diff --git a/packages/docs/src/docs/pattern-hiding.md b/packages/docs/src/docs/pattern-hiding.md index 3162cbec6..e511bed4f 100644 --- a/packages/docs/src/docs/pattern-hiding.md +++ b/packages/docs/src/docs/pattern-hiding.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 170 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Removing a pattern from Pattern Lab's drop-down navigation and style guide is accomplished by setting the `hidden` frontmatter key on any pattern's companion `.md` file. For example, we may have a Google Map-based pattern that we don't need for a particular project. The path might look like: diff --git a/packages/docs/src/docs/pattern-including.md b/packages/docs/src/docs/pattern-including.md index 05c2247e3..2b55d9e17 100644 --- a/packages/docs/src/docs/pattern-including.md +++ b/packages/docs/src/docs/pattern-including.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 90 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- To include one pattern within another, for example to create a molecule from several atoms, you can either use: diff --git a/packages/docs/src/docs/pattern-managing-assets.md b/packages/docs/src/docs/pattern-managing-assets.md index 81e955c17..c7c52c666 100644 --- a/packages/docs/src/docs/pattern-managing-assets.md +++ b/packages/docs/src/docs/pattern-managing-assets.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 120 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Assets for patterns - including JavaScript, CSS, and images - should be stored and edited in the `./source/` directory. Pattern Lab will move these assets to the `./public/` directory for you when you generate your site or when you watch the `./source/` directory for changes. _You can name and organize your assets however you like._ If you would like to use `./source/stylesheets/` to store your styles instead of `./source/css/` you can do that. The structure will be maintained when they're moved to the `./public/` directory. diff --git a/packages/docs/src/docs/pattern-organization.md b/packages/docs/src/docs/pattern-organization.md index 9b51552da..9119fac98 100644 --- a/packages/docs/src/docs/pattern-organization.md +++ b/packages/docs/src/docs/pattern-organization.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 10 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Patterns can be found in `./source/_patterns/`. Patterns must be written in the template languages supported by Pattern Lab's PatternEngines. For Node there are [several more PatternEngines to choose from](/docs/template-language-and-patternengines/). diff --git a/packages/docs/src/docs/pattern-parameters.md b/packages/docs/src/docs/pattern-parameters.md index 400f1f9e6..5b040e926 100644 --- a/packages/docs/src/docs/pattern-parameters.md +++ b/packages/docs/src/docs/pattern-parameters.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 150 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- **Important:** Pattern parameters are supported by the Node Mustache PatternEngines. Other template languages provide better solutions to this problem. diff --git a/packages/docs/src/docs/pattern-pseudo-patterns.md b/packages/docs/src/docs/pattern-pseudo-patterns.md index 2ee892832..397cc39bc 100644 --- a/packages/docs/src/docs/pattern-pseudo-patterns.md +++ b/packages/docs/src/docs/pattern-pseudo-patterns.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 140 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pseudo-patterns give developers and designers the ability to quickly build multiple unique variants of an existing pattern. This feature is especially useful when developing template- and page-style patterns or showing the states of other patterns. diff --git a/packages/docs/src/docs/pattern-reorganizing.md b/packages/docs/src/docs/pattern-reorganizing.md index ea2491dba..1d2b80242 100644 --- a/packages/docs/src/docs/pattern-reorganizing.md +++ b/packages/docs/src/docs/pattern-reorganizing.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 80 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- By default, the Node version of Pattern Lab organizes pattern groups, pattern subgroups, and patterns alphabetically when displaying them in the drop-down navigation, pattern subgroup "view all" pages, and the "all" style guide. This may not meet your needs. You can re-order pattern groups, pattern subgroups, and patterns by prefixing them with two-digit numbers. diff --git a/packages/docs/src/docs/pattern-states.md b/packages/docs/src/docs/pattern-states.md index 3da67d9e3..3198faf91 100644 --- a/packages/docs/src/docs/pattern-states.md +++ b/packages/docs/src/docs/pattern-states.md @@ -8,6 +8,7 @@ eleventyNavigation: key: patterns order: 160 sitemapPriority: '0.8' +sitemapChangefreq: 'monthly' --- Pattern states provide your team and client a simple visual of the current state of patterns in Pattern Lab. Pattern states can track progress of a pattern from development, through client review, to completion or they can be used to give certain patterns specific classes. It's important to note that the state of a pattern can be influenced by its pattern partials. diff --git a/packages/docs/src/index.md b/packages/docs/src/index.md index 5dfd66a1d..f84d95851 100644 --- a/packages/docs/src/index.md +++ b/packages/docs/src/index.md @@ -2,4 +2,5 @@ layout: home title: Create atomic design systems with Pattern Lab sitemapPriority: '1.0' +sitemapChangefreq: 'monthly' --- From eea9fc73c4ae4ee64a1484428cfec59612d180a2 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 19:30:09 +0200 Subject: [PATCH 19/23] feat(docs): added some sitemap generation metadata --- packages/docs/src/admin.njk | 1 + packages/docs/src/archive.md | 1 + packages/docs/src/docs/a-post-with-code-samples.md | 1 + packages/docs/src/docs/changes-1-to-2.md | 1 + packages/docs/src/docs/php-compile.md | 1 + packages/docs/src/feed.njk | 1 + packages/docs/src/styleguide.njk | 3 ++- packages/docs/src/updates.md | 1 + 8 files changed, 9 insertions(+), 1 deletion(-) diff --git a/packages/docs/src/admin.njk b/packages/docs/src/admin.njk index c1c5517d1..84993a16c 100644 --- a/packages/docs/src/admin.njk +++ b/packages/docs/src/admin.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true permalink: '/admin/index.html' --- diff --git a/packages/docs/src/archive.md b/packages/docs/src/archive.md index 76533c10f..e3d74d95a 100644 --- a/packages/docs/src/archive.md +++ b/packages/docs/src/archive.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: 'Posts Archive' layout: 'layouts/archive.njk' --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index 156a0d13c..35827621d 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: DOCS DOCS DOCS tags: - demo-content diff --git a/packages/docs/src/docs/changes-1-to-2.md b/packages/docs/src/docs/changes-1-to-2.md index b167ba607..4cfd21391 100644 --- a/packages/docs/src/docs/changes-1-to-2.md +++ b/packages/docs/src/docs/changes-1-to-2.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: Pattern Lab 1 to Pattern Lab 2 Changes tags: - docs diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 54c4e7a7e..9201ebe17 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: php-compile tags: - demo-content diff --git a/packages/docs/src/feed.njk b/packages/docs/src/feed.njk index 11c50e48f..d789f41b8 100644 --- a/packages/docs/src/feed.njk +++ b/packages/docs/src/feed.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true permalink: '/feed.xml' --- diff --git a/packages/docs/src/styleguide.njk b/packages/docs/src/styleguide.njk index 66d64be12..890178447 100644 --- a/packages/docs/src/styleguide.njk +++ b/packages/docs/src/styleguide.njk @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: 'Styleguide' permalink: /styleguide/ --- @@ -22,7 +23,7 @@ permalink: /styleguide/ } .props dt { - font-weight: 600; + font-weight: 600; } .props dd + dt { diff --git a/packages/docs/src/updates.md b/packages/docs/src/updates.md index 09a9c2d73..08231fd10 100644 --- a/packages/docs/src/updates.md +++ b/packages/docs/src/updates.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true layout: layouts/blog.njk title: Pattern Lab Updates description: The latest news about the Pattern Lab project From 798de2d618963b7676377f190ea9a7593d6aec11 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 19:34:13 +0200 Subject: [PATCH 20/23] refactor(docs): prevent extra slash at generated URLs --- packages/docs/src/_data/site.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/src/_data/site.json b/packages/docs/src/_data/site.json index 8a5e4ce23..555f61950 100644 --- a/packages/docs/src/_data/site.json +++ b/packages/docs/src/_data/site.json @@ -2,7 +2,7 @@ "showThemeCredit": true, "name": "Pattern Lab", "shortDesc": "Pattern Lab is a frontend workshop environment that helps you build, view, test, and showcase your design system's UI components.", - "url": "https://patternlab.io/", + "url": "https://patternlab.io", "authorEmail": "brad@bradfrost.com", "authorHandle": "@bradfrost", "authorName": "Brad Frost", From ecf1e689d9bfef5fcd46a1552122f66f6428cf28 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 19:41:08 +0200 Subject: [PATCH 21/23] feat(docs): added further sitemap generation metadata --- packages/docs/src/docs/advanced-auto-regenerate.md | 1 + packages/docs/src/resources.md | 1 + packages/docs/src/support.md | 1 + 3 files changed, 3 insertions(+) diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index 3c3257988..c6262f79e 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -1,4 +1,5 @@ --- +eleventyExcludeFromCollections: true title: Watching for Changes and Auto Regenerating Patterns tags: - docs diff --git a/packages/docs/src/resources.md b/packages/docs/src/resources.md index 9c6681825..5755fe103 100644 --- a/packages/docs/src/resources.md +++ b/packages/docs/src/resources.md @@ -1,6 +1,7 @@ --- layout: layouts/page-base.njk title: Resources +sitemapPriority: '0.8' --- ## Style guides and atomic design diff --git a/packages/docs/src/support.md b/packages/docs/src/support.md index 9a1ee1c4f..9f227fbc0 100644 --- a/packages/docs/src/support.md +++ b/packages/docs/src/support.md @@ -1,6 +1,7 @@ --- layout: layouts/post.njk title: Pattern Lab Support +sitemapPriority: '0.8' --- ## GitHub From e1623e6f75ad685bde0567a37e745f474c8fa37d Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 22:34:21 +0200 Subject: [PATCH 22/23] chore: moved to an exclusive data entry for ignoring sitemap items --- packages/docs/src/404.md | 2 +- packages/docs/src/admin.njk | 2 +- packages/docs/src/archive.md | 2 +- packages/docs/src/demos/bolt-design-systems.md | 1 + .../src/demos/handlebars-base-starterkit.md | 1 + .../src/demos/handlebars-demo-starterkit.md | 1 + .../src/demos/handlebars-vanilla-starterkit.md | 1 + .../docs/src/docs/a-post-with-code-samples.md | 2 +- .../docs/src/docs/advanced-auto-regenerate.md | 2 +- packages/docs/src/docs/changes-1-to-2.md | 2 +- packages/docs/src/docs/php-compile.md | 2 +- packages/docs/src/feed.njk | 2 +- packages/docs/src/robots.njk | 4 ++-- packages/docs/src/sitemap.njk | 18 ++++++++++-------- packages/docs/src/styleguide.njk | 2 +- packages/docs/src/updates.md | 2 +- 16 files changed, 26 insertions(+), 20 deletions(-) diff --git a/packages/docs/src/404.md b/packages/docs/src/404.md index eccd5a45c..b69a2386a 100644 --- a/packages/docs/src/404.md +++ b/packages/docs/src/404.md @@ -2,7 +2,7 @@ title: '404 - not found' layout: layouts/page.njk permalink: 404.html -eleventyExcludeFromCollections: true +sitemapIgnore: true --- We’re sorry, but that content can’t be found. Please go [back to home](/). diff --git a/packages/docs/src/admin.njk b/packages/docs/src/admin.njk index 84993a16c..56f0d6566 100644 --- a/packages/docs/src/admin.njk +++ b/packages/docs/src/admin.njk @@ -1,6 +1,6 @@ --- -eleventyExcludeFromCollections: true permalink: '/admin/index.html' +sitemapIgnore: true --- diff --git a/packages/docs/src/archive.md b/packages/docs/src/archive.md index e3d74d95a..e594fe388 100644 --- a/packages/docs/src/archive.md +++ b/packages/docs/src/archive.md @@ -1,5 +1,5 @@ --- -eleventyExcludeFromCollections: true title: 'Posts Archive' layout: 'layouts/archive.njk' +sitemapIgnore: true --- diff --git a/packages/docs/src/demos/bolt-design-systems.md b/packages/docs/src/demos/bolt-design-systems.md index fee5de8d2..107fd44fc 100644 --- a/packages/docs/src/demos/bolt-design-systems.md +++ b/packages/docs/src/demos/bolt-design-systems.md @@ -8,4 +8,5 @@ tags: - demo-content - code refLink: https://boltdesignsystem.com/pattern-lab/?p=pages-d8-homepage +sitemapIgnore: true --- diff --git a/packages/docs/src/demos/handlebars-base-starterkit.md b/packages/docs/src/demos/handlebars-base-starterkit.md index 4bf089ccb..dccdb1107 100644 --- a/packages/docs/src/demos/handlebars-base-starterkit.md +++ b/packages/docs/src/demos/handlebars-base-starterkit.md @@ -8,4 +8,5 @@ tags: - demo-content - code refLink: https://patternlab-handlebars-preview.netlify.app/?p=all +sitemapIgnore: true --- diff --git a/packages/docs/src/demos/handlebars-demo-starterkit.md b/packages/docs/src/demos/handlebars-demo-starterkit.md index 12d0dd700..6fc51cfa6 100644 --- a/packages/docs/src/demos/handlebars-demo-starterkit.md +++ b/packages/docs/src/demos/handlebars-demo-starterkit.md @@ -8,4 +8,5 @@ tags: - demo-content - code refLink: https://patternlab-handlebars-preview.netlify.app/?p=all +sitemapIgnore: true --- diff --git a/packages/docs/src/demos/handlebars-vanilla-starterkit.md b/packages/docs/src/demos/handlebars-vanilla-starterkit.md index 9f581b773..677c3cf29 100644 --- a/packages/docs/src/demos/handlebars-vanilla-starterkit.md +++ b/packages/docs/src/demos/handlebars-vanilla-starterkit.md @@ -8,4 +8,5 @@ tags: - demo-content - code refLink: https://patternlab-handlebars-preview.netlify.app/?p=all +sitemapIgnore: true --- diff --git a/packages/docs/src/docs/a-post-with-code-samples.md b/packages/docs/src/docs/a-post-with-code-samples.md index 35827621d..dac628f4c 100644 --- a/packages/docs/src/docs/a-post-with-code-samples.md +++ b/packages/docs/src/docs/a-post-with-code-samples.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: DOCS DOCS DOCS tags: - demo-content @@ -9,6 +8,7 @@ eleventyNavigation: key: DOCS DOCS DOCS order: 300 sitemapPriority: '0.8' +sitemapIgnore: true --- The best way to demo a code post is to display a real life post, so check out this one from [andy-bell.design](https://andy-bell.design/wrote/creating-a-full-bleed-css-utility/) about a full bleed CSS utility. diff --git a/packages/docs/src/docs/advanced-auto-regenerate.md b/packages/docs/src/docs/advanced-auto-regenerate.md index c6262f79e..ee07c4da5 100644 --- a/packages/docs/src/docs/advanced-auto-regenerate.md +++ b/packages/docs/src/docs/advanced-auto-regenerate.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: Watching for Changes and Auto Regenerating Patterns tags: - docs @@ -9,6 +8,7 @@ eleventyNavigation: parent: advanced order: 300 sitemapPriority: '0.8' +sitemapIgnore: true --- Pattern Lab has the ability to watch for changes to patterns and frontend assets. When these files change, it will automatically rebuild the entire Pattern Lab website. You simply make your changes, save the file, and Pattern Lab will take care of the rest. diff --git a/packages/docs/src/docs/changes-1-to-2.md b/packages/docs/src/docs/changes-1-to-2.md index 4cfd21391..98abb3a67 100644 --- a/packages/docs/src/docs/changes-1-to-2.md +++ b/packages/docs/src/docs/changes-1-to-2.md @@ -1,11 +1,11 @@ --- -eleventyExcludeFromCollections: true title: Pattern Lab 1 to Pattern Lab 2 Changes tags: - docs eleventyNavigation: title: Pattern Lab 1 to Pattern Lab 2 Changes order: 300 +sitemapIgnore: true --- The list of features is coming soon. diff --git a/packages/docs/src/docs/php-compile.md b/packages/docs/src/docs/php-compile.md index 9201ebe17..6727f4362 100644 --- a/packages/docs/src/docs/php-compile.md +++ b/packages/docs/src/docs/php-compile.md @@ -1,5 +1,4 @@ --- -eleventyExcludeFromCollections: true title: php-compile tags: - demo-content @@ -9,6 +8,7 @@ eleventyNavigation: key: php-compile order: 300 sitemapChangefreq: 'never' +sitemapIgnore: true --- The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. The PHP docs for this topic can be viewed here. diff --git a/packages/docs/src/feed.njk b/packages/docs/src/feed.njk index d789f41b8..70001f5f2 100644 --- a/packages/docs/src/feed.njk +++ b/packages/docs/src/feed.njk @@ -1,6 +1,6 @@ --- -eleventyExcludeFromCollections: true permalink: '/feed.xml' +sitemapIgnore: true --- diff --git a/packages/docs/src/robots.njk b/packages/docs/src/robots.njk index efb8b84f1..08ba9aeb4 100644 --- a/packages/docs/src/robots.njk +++ b/packages/docs/src/robots.njk @@ -1,7 +1,7 @@ --- -eleventyExcludeFromCollections: true permalink: /robots.txt +sitemapIgnore: true --- User-agent: * Allow: / -Sitemap: {{ site.url }}/sitemap.xml \ No newline at end of file +Sitemap: {{ site.url }}/sitemap.xml diff --git a/packages/docs/src/sitemap.njk b/packages/docs/src/sitemap.njk index c912abda4..d87ee9df4 100644 --- a/packages/docs/src/sitemap.njk +++ b/packages/docs/src/sitemap.njk @@ -1,15 +1,17 @@ --- -eleventyExcludeFromCollections: true permalink: /sitemap.xml +sitemapIgnore: true --- {% for item in collections.all %} - - {{ site.url }}{{ item.url }} - {{ item.date | w3DateFilter()}} - {{ item.data.sitemapChangefreq | default("yearly") }} - {{ item.data.sitemapPriority | default(0.7) }} - +{% if not item.data.sitemapIgnore %} + + {{ site.url }}{{ item.url }} + {{ item.date | w3DateFilter()}} + {{ item.data.sitemapChangefreq | default("yearly") }} + {{ item.data.sitemapPriority | default(0.7) }} + +{% endif %} {% endfor %} - \ No newline at end of file + diff --git a/packages/docs/src/styleguide.njk b/packages/docs/src/styleguide.njk index 890178447..e7e2fc117 100644 --- a/packages/docs/src/styleguide.njk +++ b/packages/docs/src/styleguide.njk @@ -1,7 +1,7 @@ --- -eleventyExcludeFromCollections: true title: 'Styleguide' permalink: /styleguide/ +sitemapIgnore: true --- {% extends 'layouts/base.njk' %} diff --git a/packages/docs/src/updates.md b/packages/docs/src/updates.md index 08231fd10..b2a2be380 100644 --- a/packages/docs/src/updates.md +++ b/packages/docs/src/updates.md @@ -1,6 +1,6 @@ --- -eleventyExcludeFromCollections: true layout: layouts/blog.njk title: Pattern Lab Updates description: The latest news about the Pattern Lab project +sitemapIgnore: true --- From eb3e8a0b75609ec5972ff9a17cb0e18cde1f79d9 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sat, 29 May 2021 22:35:40 +0200 Subject: [PATCH 23/23] chore: ignoring tags --- packages/docs/src/tags.njk | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/docs/src/tags.njk b/packages/docs/src/tags.njk index a7cc28d69..fc07b9b12 100644 --- a/packages/docs/src/tags.njk +++ b/packages/docs/src/tags.njk @@ -13,6 +13,7 @@ pagination: - postFeed addAllPagesToCollections: true permalink: /tags/{{ tag }}/ +sitemapIgnore: true --- {% extends 'layouts/base.njk' %}