diff --git a/README.md b/README.md index cd621433a..80a975a0f 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Refer to the [core usage guidelines](https://github.com/pattern-lab/patternlab-n ### Installation -As of Pattern Lab Node 3.0.0, installation of [Editions](http://patternlab.io/docs/advanced-ecosystem-overview.html) is accomplished via the command line interface. +As of Pattern Lab Node 3.0.0, installation of [Editions](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/) is accomplished via the command line interface. The below assumes a new directory and project is required. This is likely what you want to do if starting from scratch. You could also run this within an existing project. The CLI will ask you for the installation location. @@ -48,7 +48,7 @@ The below assumes a new directory and project is required. This is likely what y ![Pattern Lab Ecosystem](http://patternlab.io/assets/pattern-lab-2-image_18-large-opt.png) -Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines. +Core, and Editions, are part of the [Pattern Lab Ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines. ## Changelog diff --git a/packages/core/README.md b/packages/core/README.md index f6a81c7bd..1967a2dda 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -10,7 +10,7 @@ # Pattern Lab Node Core -This is the core API and orchestrator of the [Pattern Lab ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). +This is the core API and orchestrator of the [Pattern Lab ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). ## Installation @@ -37,7 +37,7 @@ For users wanting a more pre-packaged experience several editions are available. ![Pattern Lab Ecosystem](http://patternlab.io/assets/pattern-lab-2-image_18-large-opt.png) -Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines. +Core, and Editions, are part of the [Pattern Lab Ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines. ## Usage @@ -59,7 +59,7 @@ patternlab.serve({ }); ``` -* Read more about [configuration](http://patternlab.io/docs/advanced-config-options.html#node) via `patternlab-config.json`. +* Read more about [configuration](https://patternlab.io/docs/editing-the-configuration-options/) via `patternlab-config.json`. * Read more about the rest of [Public API](./docs), and already implemented for you within [Editions](#editions). diff --git a/packages/core/src/lib/loadPattern.js b/packages/core/src/lib/loadPattern.js index c0fb1d6a5..97ba7504e 100644 --- a/packages/core/src/lib/loadPattern.js +++ b/packages/core/src/lib/loadPattern.js @@ -48,7 +48,7 @@ module.exports = function(relPath, patternlab) { 'While Pattern Lab may still function, assets may 404 and frontend links may break. Consider yourself warned. ' ); logger.warning( - 'Read More: http://patternlab.io/docs/pattern-organization.html' + 'Read More: https://patternlab.io/docs/overview-of-patterns/' ); logger.warning(''); } diff --git a/packages/core/test/engine_handlebars_tests.js b/packages/core/test/engine_handlebars_tests.js index d268c1c63..aed179797 100644 --- a/packages/core/test/engine_handlebars_tests.js +++ b/packages/core/test/engine_handlebars_tests.js @@ -61,7 +61,7 @@ function testFindPartials(test, partialTests) { // setup current pattern from what we would have during execution // docs on partial syntax are here: - // http://patternlab.io/docs/pattern-including.html + // https://patternlab.io/docs/including-patterns/ var currentPattern = Pattern.create( '01-molecules/00-testing/00-test-mol.hbs', // relative path now null, // data diff --git a/packages/core/test/engine_liquid_tests.js b/packages/core/test/engine_liquid_tests.js index 9036dbca1..a03d7336a 100644 --- a/packages/core/test/engine_liquid_tests.js +++ b/packages/core/test/engine_liquid_tests.js @@ -49,7 +49,7 @@ function testFindPartials(test, partialTests) { // setup current pattern from what we would have during execution // docs on partial syntax are here: - // http://patternlab.io/docs/pattern-including.html + // https://patternlab.io/docs/including-patterns/ var currentPattern = Pattern.create( '01-molecules/00-testing/00-test-mol.liquid', // relative path now null, // data diff --git a/packages/core/test/engine_mustache_tests.js b/packages/core/test/engine_mustache_tests.js index 8f0241d24..d3b81d5ec 100644 --- a/packages/core/test/engine_mustache_tests.js +++ b/packages/core/test/engine_mustache_tests.js @@ -50,7 +50,7 @@ function testFindPartials(test, partialTests) { // setup current pattern from what we would have during execution // docs on partial syntax are here: - // http://patternlab.io/docs/pattern-including.html + // https://patternlab.io/docs/including-patterns/ var currentPattern = Pattern.create( '01-molecules/00-testing/00-test-mol.mustache', // relative path now null, // data @@ -76,7 +76,7 @@ function testFindPartialsWithStyleModifiers(test, partialTests) { // setup current pattern from what we would have during execution // docs on partial syntax are here: - // http://patternlab.io/docs/pattern-including.html + // https://patternlab.io/docs/including-patterns/ var currentPattern = Pattern.create( '01-molecules/00-testing/00-test-mol.mustache', // relative path now null, // data @@ -102,7 +102,7 @@ function testFindPartialsWithPatternParameters(test, partialTests) { // setup current pattern from what we would have during execution // docs on partial syntax are here: - // http://patternlab.io/docs/pattern-including.html + // https://patternlab.io/docs/including-patterns/ var currentPattern = Pattern.create( '01-molecules/00-testing/00-test-mol.mustache', // relative path now null, // data diff --git a/packages/core/test/engine_twig_tests.js b/packages/core/test/engine_twig_tests.js index 33a49bbe9..6bf3ab2e3 100644 --- a/packages/core/test/engine_twig_tests.js +++ b/packages/core/test/engine_twig_tests.js @@ -49,7 +49,7 @@ function testFindPartials(test, partialTests) { // setup current pattern from what we would have during execution // docs on partial syntax are here: - // http://patternlab.io/docs/pattern-including.html + // https://patternlab.io/docs/including-patterns/ var currentPattern = Pattern.create( '01-molecules/00-testing/00-test-mol.twig', // relative path now null, // data diff --git a/packages/development-edition-engine-handlebars/README.md b/packages/development-edition-engine-handlebars/README.md index 5bb88ff96..27766e215 100644 --- a/packages/development-edition-engine-handlebars/README.md +++ b/packages/development-edition-engine-handlebars/README.md @@ -9,7 +9,7 @@ This Development Edition is a variant of [Edition Node](https://github.com/patte * Develop the [Handlebars Engine](https://github.com/pattern-lab/patternlab-node/tree/master/packages/engine-handlebars) * Build and test against Handlebars pattern tree -> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable. +> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). This Edition is NOT stable. ## Working on Pattern Lab's UI Locally diff --git a/packages/development-edition-engine-handlebars/source/_meta/README.md b/packages/development-edition-engine-handlebars/source/_meta/README.md index c6c8c3b8e..b5d2c4537 100644 --- a/packages/development-edition-engine-handlebars/source/_meta/README.md +++ b/packages/development-edition-engine-handlebars/source/_meta/README.md @@ -1,5 +1,5 @@ This is the default location to place meta files, otherwise known a pattern's header and footer. -Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html). +Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/). If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`. diff --git a/packages/development-edition-engine-react/README.md b/packages/development-edition-engine-react/README.md index bdb531d95..2c21a20f4 100644 --- a/packages/development-edition-engine-react/README.md +++ b/packages/development-edition-engine-react/README.md @@ -11,4 +11,4 @@ This Development Edition is a variant of [Edition Node Gulp](https://github.com/ If you'd like to help with the React Engine, please reference the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md). -> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable. +> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). This Edition is NOT stable. diff --git a/packages/development-edition-engine-react/source/_annotations/README.md b/packages/development-edition-engine-react/source/_annotations/README.md index 42592a09b..b67b5511f 100644 --- a/packages/development-edition-engine-react/source/_annotations/README.md +++ b/packages/development-edition-engine-react/source/_annotations/README.md @@ -1,5 +1,5 @@ This is the default location to place annotations. -Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html). +Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](https://patternlab.io/docs/adding-annotations/). If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`. diff --git a/packages/development-edition-engine-react/source/_meta/README.md b/packages/development-edition-engine-react/source/_meta/README.md index c6c8c3b8e..b5d2c4537 100644 --- a/packages/development-edition-engine-react/source/_meta/README.md +++ b/packages/development-edition-engine-react/source/_meta/README.md @@ -1,5 +1,5 @@ This is the default location to place meta files, otherwise known a pattern's header and footer. -Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html). +Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/). If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`. diff --git a/packages/development-edition-engine-react/source/_patterns/README.md b/packages/development-edition-engine-react/source/_patterns/README.md index 2f89266bf..8751c8669 100644 --- a/packages/development-edition-engine-react/source/_patterns/README.md +++ b/packages/development-edition-engine-react/source/_patterns/README.md @@ -1,5 +1,5 @@ This is the default location to place pattern files. -Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](http://patternlab.io/docs/pattern-organization.html). +Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](https://patternlab.io/docs/overview-of-patterns/). If you wish to rename this directory, make sure you update the `paths.source.patterns` property within `patternlab-config.json`. diff --git a/packages/development-edition-engine-twig/README.md b/packages/development-edition-engine-twig/README.md index 5ea6dce7b..b3ffdea7f 100644 --- a/packages/development-edition-engine-twig/README.md +++ b/packages/development-edition-engine-twig/README.md @@ -9,7 +9,7 @@ This Development Edition is a variant of [Edition Node](https://github.com/patte * Develop the [Twig Engine](https://github.com/pattern-lab/patternlab-node/tree/master/packages/engine-twig) * Build and test against Twig pattern tree -> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable. +> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). This Edition is NOT stable. ## Working on Pattern Lab's UI Locally diff --git a/packages/edition-node-gulp/source/_annotations/README.md b/packages/edition-node-gulp/source/_annotations/README.md index 42592a09b..b67b5511f 100644 --- a/packages/edition-node-gulp/source/_annotations/README.md +++ b/packages/edition-node-gulp/source/_annotations/README.md @@ -1,5 +1,5 @@ This is the default location to place annotations. -Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html). +Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](https://patternlab.io/docs/adding-annotations/). If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`. diff --git a/packages/edition-node-gulp/source/_meta/README.md b/packages/edition-node-gulp/source/_meta/README.md index c6c8c3b8e..b5d2c4537 100644 --- a/packages/edition-node-gulp/source/_meta/README.md +++ b/packages/edition-node-gulp/source/_meta/README.md @@ -1,5 +1,5 @@ This is the default location to place meta files, otherwise known a pattern's header and footer. -Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html). +Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/). If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`. diff --git a/packages/edition-node-gulp/source/_patterns/README.md b/packages/edition-node-gulp/source/_patterns/README.md index 2f89266bf..8751c8669 100644 --- a/packages/edition-node-gulp/source/_patterns/README.md +++ b/packages/edition-node-gulp/source/_patterns/README.md @@ -1,5 +1,5 @@ This is the default location to place pattern files. -Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](http://patternlab.io/docs/pattern-organization.html). +Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](https://patternlab.io/docs/overview-of-patterns/). If you wish to rename this directory, make sure you update the `paths.source.patterns` property within `patternlab-config.json`. diff --git a/packages/edition-node/source/_annotations/README.md b/packages/edition-node/source/_annotations/README.md index 42592a09b..b67b5511f 100644 --- a/packages/edition-node/source/_annotations/README.md +++ b/packages/edition-node/source/_annotations/README.md @@ -1,5 +1,5 @@ This is the default location to place annotations. -Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html). +Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](https://patternlab.io/docs/adding-annotations/). If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`. diff --git a/packages/edition-node/source/_meta/README.md b/packages/edition-node/source/_meta/README.md index c6c8c3b8e..b5d2c4537 100644 --- a/packages/edition-node/source/_meta/README.md +++ b/packages/edition-node/source/_meta/README.md @@ -1,5 +1,5 @@ This is the default location to place meta files, otherwise known a pattern's header and footer. -Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html). +Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/). If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`. diff --git a/packages/edition-node/source/_patterns/README.md b/packages/edition-node/source/_patterns/README.md index 2f89266bf..8751c8669 100644 --- a/packages/edition-node/source/_patterns/README.md +++ b/packages/edition-node/source/_patterns/README.md @@ -1,5 +1,5 @@ This is the default location to place pattern files. -Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](http://patternlab.io/docs/pattern-organization.html). +Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](https://patternlab.io/docs/overview-of-patterns/). If you wish to rename this directory, make sure you update the `paths.source.patterns` property within `patternlab-config.json`. diff --git a/packages/engine-handlebars/README.md b/packages/engine-handlebars/README.md index 2dc828d60..3c0669adb 100644 --- a/packages/engine-handlebars/README.md +++ b/packages/engine-handlebars/README.md @@ -4,7 +4,7 @@ To install the Handlebars PatternEngine in your edition, `npm install --save @pa ## Supported features -* [x] [Includes](http://patternlab.io/docs/pattern-including.html) +* [x] [Includes](https://patternlab.io/docs/including-patterns/) * [x] Lineage * [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) * [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) diff --git a/packages/engine-liquid/README.md b/packages/engine-liquid/README.md index 518aba27f..344a34292 100644 --- a/packages/engine-liquid/README.md +++ b/packages/engine-liquid/README.md @@ -10,7 +10,7 @@ To install the Liquid PatternEngine in your edition, `npm install @pattern-lab/e This PatternEngine is in alpha and considered a work in progress. -* [x] [Includes](http://patternlab.io/docs/pattern-including.html) +* [x] [Includes](https://patternlab.io/docs/including-patterns/) * [x] Lineage **TBD** diff --git a/packages/engine-nunjucks/README.md b/packages/engine-nunjucks/README.md index 9d6ab1c99..0aa2df954 100644 --- a/packages/engine-nunjucks/README.md +++ b/packages/engine-nunjucks/README.md @@ -5,7 +5,7 @@ To install the Nunjucks PatternEngine in your edition, run `npm install @pattern-lab/engine-nunjucks`. ## Supported features -- [x] [Includes](http://patternlab.io/docs/pattern-including.html) +- [x] [Includes](https://patternlab.io/docs/including-patterns/) - [x] Lineage - [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) - [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) diff --git a/packages/engine-react/README.md b/packages/engine-react/README.md index 028006981..e30eb199a 100644 --- a/packages/engine-react/README.md +++ b/packages/engine-react/README.md @@ -14,7 +14,7 @@ To install the React PatternEngine in your edition, `npm install @pattern-lab/en ## Supported features -* [x] [Includes](http://patternlab.io/docs/pattern-including.html) +* [x] [Includes](https://patternlab.io/docs/including-patterns/) * [x] Data inheritance: This can be achieved by combining react `props` & `defaultProps` * [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) * [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html) diff --git a/packages/engine-underscore/README.md b/packages/engine-underscore/README.md index 59796d51f..975b27bf0 100644 --- a/packages/engine-underscore/README.md +++ b/packages/engine-underscore/README.md @@ -6,7 +6,7 @@ To install the Underscore PatternEngine in your edition, `npm install @pattern-l ## Supported features -* [x] [Includes](http://patternlab.io/docs/pattern-including.html) (Accomplished using the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternlab-node/blob/master/packages/engine-underscore/lib/engine_underscore.js#L54-L60)) +* [x] [Includes](https://patternlab.io/docs/including-patterns/) (Accomplished using the included [`_.renderNamedPartial()`](https://github.com/pattern-lab/patternlab-node/blob/master/packages/engine-underscore/lib/engine_underscore.js#L54-L60)) * [x] Lineage * [x] [Hidden Patterns](http://patternlab.io/docs/pattern-hiding.html) * [x] [Pseudo-Patterns](http://patternlab.io/docs/pattern-pseudo-patterns.html)