From b4f36842d12e65874e726ccdbdfcb3d4dbc087cc Mon Sep 17 00:00:00 2001 From: Josef Bredreck Date: Mon, 11 Jan 2021 11:26:12 +0100 Subject: [PATCH] remove unused documentation files --- .../docs/src/docs/advanced-generating-css.md | 22 ---------- .../docs/advanced-integration-with-compass.md | 34 -------------- .../docs/advanced-integration-with-grunt.md | 41 ----------------- .../docs/src/docs/advanced-page-follow.md | 44 ------------------- packages/docs/src/docs/pattern-converting.md | 20 --------- 5 files changed, 161 deletions(-) delete mode 100644 packages/docs/src/docs/advanced-generating-css.md delete mode 100644 packages/docs/src/docs/advanced-integration-with-compass.md delete mode 100644 packages/docs/src/docs/advanced-integration-with-grunt.md delete mode 100644 packages/docs/src/docs/advanced-page-follow.md delete mode 100644 packages/docs/src/docs/pattern-converting.md diff --git a/packages/docs/src/docs/advanced-generating-css.md b/packages/docs/src/docs/advanced-generating-css.md deleted file mode 100644 index 74c2c539f..000000000 --- a/packages/docs/src/docs/advanced-generating-css.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Generating CSS -tags: - - docs -category: advanced -eleventyNavigation: - title: Generating CSS - key: advanced - order: 300 ---- - -**Note:** _The [CSS Rule Saver](https://github.com/dmolsen/css-rule-saver) library and CSS generation feature was added in v0.6.0 of the PHP version of Pattern Lab._ - -When using this feature, Pattern Lab can display only those CSS rules that affect a given pattern on the pattern detail view. This might be useful if you have a large Sass-generated CSS file or framework but only need a sub-set of styles that may affect a small piece of mark-up or pattern. - -## How to Generate the CSS - -To generate your Pattern Lab site with CSS support on Mac OS X you can do the following: - -1. Open `core/scripts/` -2. Double-click `generateSiteWithCSS.command` -3. Refresh the Pattern Lab site diff --git a/packages/docs/src/docs/advanced-integration-with-compass.md b/packages/docs/src/docs/advanced-integration-with-compass.md deleted file mode 100644 index 359a67273..000000000 --- a/packages/docs/src/docs/advanced-integration-with-compass.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Integration with Compass -tags: - - docs -category: advanced -eleventyNavigation: - title: Integration with Compass - key: advanced - order: 300 ---- - -**Note:** _These directions incomplete. They are not meant to imply that Compass is officially supported with Pattern Lab. They should be modified to fit your instance of the PHP version of Pattern Lab._ - -Setting up Compass to work with the PHP version of Pattern Lab should be really straightforward. To set-up a Compass config that uses SCSS and _doesn't_ install any starter stylesheets do the following: - -1. Open Terminal on a Mac -2. `gem install compass` (if you don't have it) -3. `cd /source` -4. `compass create --bare --sass-dir "css" --css-dir "css" --javascripts-dir "js" --images-dir "images"` - -The directories provided in step #4 are based on the default install of the PHP version of Pattern Lab and should be updated to reflect your directory structure. Also, if you need Compass to watch other directories or implement features modify step #4 as appropriate. - -## Workflow with Pattern Lab - -Compass will only recompile your SCSS. To get Pattern Lab to rebuild your entire site as well as reload the browser when your SCSS files have been updated do the following: - -1. Open Terminal on a Mac -2. `cd ` -3. `compass watch source` -4. Open a new tab in Terminal -5. `php core/builder.php -wr` -6. Reload your browser - -As you make changes to the SCSS files Compass will recompile them and, seeing the changes to `styles.css`, the PHP version of Pattern Lab will rebuild the entire site. It should also reload the Pattern Lab website. diff --git a/packages/docs/src/docs/advanced-integration-with-grunt.md b/packages/docs/src/docs/advanced-integration-with-grunt.md deleted file mode 100644 index 1d85f666c..000000000 --- a/packages/docs/src/docs/advanced-integration-with-grunt.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Integration with Grunt/Gulp -tags: - - docs -category: advanced -eleventyNavigation: - title: Integration with Grunt/Gulp - key: advanced - order: 300 ---- - -**Note:** _These directions may be incomplete. They also require **v0.7.9** of the PHP version of Pattern Lab._ - -Setting up Grunt to work with the PHP version of Pattern Lab should be straightforward. To do so please do the following: - -1. Open a terminal window -2. Type `npm install --save-dev grunt-shell` to install [grunt-shell](https://github.com/sindresorhus/grunt-shell) -3. Add the following to your `grunt.initConfig`. The `-p` flag ensures that Pattern Lab only generates patterns. - -
shell: {
-  patternlab: {
-    command: "php core/builder.php -gp"
-  }
-}
- -4. Add `grunt.loadNpmTasks('grunt-shell');` to your list of plugins. -5. Add `'shell:patternlab'` to your list of tasks in `grunt.registerTask`. - -You should also be using `grunt-contrib-watch` to monitor changes to Pattern Lab's patterns and data. The Pattern Lab section for your `watch` might look like: - - html: { - files: ['source/_patterns/**/*.mustache', 'source/_patterns/**/*.json', 'source/_data/*.json'], - tasks: ['shell:patternlab'], - options: { - spawn: false - } - } - -You might be able to use `livereload` as well but that hasn't been tested by us yet. - -For more information, check out [this post about using Pattern Lab with Grunt](https://bradfrost.com/blog/post/using-grunt-with-pattern-lab/). diff --git a/packages/docs/src/docs/advanced-page-follow.md b/packages/docs/src/docs/advanced-page-follow.md deleted file mode 100644 index 90c668700..000000000 --- a/packages/docs/src/docs/advanced-page-follow.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Multi browser & Multi device Testing with Page Follow -tags: - - docs -category: advanced -eleventyNavigation: - title: Multi browser & Multi device Testing with Page Follow - key: advanced - order: 300 ---- - -The Pattern Lab's Page Follow feature gives developers the ability to have one browser control other browsers that connect to the Pattern Lab website. Pattern Lab Node utilizes [BrowserSync](https://www.browsersync.io/) to synchronize all connected browsers and devices. - -## How to Start and Connect to Pattern Lab with BrowserSync - -Running `gulp patternlab:serve` or `grunt patternlab:serve` from the command line of your working directory will start up Pattern Lab with BrowserSync. By default, BrowserSync will output four URLs of note: - -1. Local: [http://localhost:3000](http://localhost:3000) -2. External: http://your.ip.address:3000 -3. UI: [http://localhost:3001](http://localhost:3001) -4. UI External: http://your.ip.address:3001 - -Any browsers on your machine will be able access these URLs. Browsers on other machines or devices on the same network should use the external URLs. Connecting to the Pattern Lab website will inform users they are also connected to BrowserSync. - -## How to Stop the Page Follow - -To stop watching files on Mac OS X and Windows you can press`CTRL+C` in the command line window where the process is running. - -## BrowserSync Capabilities - -It's strongly recommended to visit [BrowserSync](https://www.browsersync.io/) documentation or the BrowserSync UI at [http://localhost:3001](http://localhost:3001). From this administration interface one can perform the following: - -- See all connected devices and browsers -- Open new tabbed instances of the Pattern Lab website on devices -- Sync all connected devices -- Reload all connected devices -- Scroll all connected devices to the top -- Toggle mouse click synchronization -- Toggle scroll synchronization -- Toggle form submission synchronization -- Toggle form input synchronization -- View browsing history of the connect session -- Toggle remote debugging tools -- Artificially throttle the network diff --git a/packages/docs/src/docs/pattern-converting.md b/packages/docs/src/docs/pattern-converting.md deleted file mode 100644 index 795eda217..000000000 --- a/packages/docs/src/docs/pattern-converting.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Converting Old Patterns -tags: - - docs -category: patterns -eleventyNavigation: - title: Converting Old Patterns - key: patterns - order: 190 ---- - -You may have invested time in building patterns for Brad's original edition of Pattern Lab but now want to convert them so they can be used with the new PHP version of Pattern Lab. To convert them all you need to do is swap out the old `inc()` calls for the Mustache-based [shorthand partials syntax](/docs/including-patterns/). For example, let's say this was a call to a pattern using the original syntax: - - - -The new Mustache-based shorthand partials syntax would be: - - {% raw %}{{> atoms-logo }}{% endraw %} - -The only real difference between the two is that the pattern type, e.g. `atoms`, has to be exact when using the Mustache partials syntax. Otherwise, it should be very easy to convert between the two formats.