Skip to content

Commit d6d3fa7

Browse files
committed
README.md: autoformat.
1 parent c592bd3 commit d6d3fa7

File tree

1 file changed

+17
-30
lines changed

1 file changed

+17
-30
lines changed

README.md

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ Patterns is a toolkit that enables designers to build rich interactive prototype
66
All functionality is triggered by classes and other attributes in the HTML, without abusing the HTML as a programming language.
77
Accessibility, SEO and well structured HTML are core values of Patterns.
88

9-
109
## Changelog
1110

1211
See the [Changelog at GitHub](https://github.com/Patternslib/Patterns/blob/master/CHANGES.md).
1312

14-
1513
## Browser support
1614

1715
Patterns aims to support at least the two latest major versions of all popular browsers:
@@ -22,7 +20,6 @@ Patterns aims to support at least the two latest major versions of all popular b
2220

2321
Other browser version may work too, but are not actively tested against.
2422

25-
2623
## Development installation requirements
2724

2825
Make sure, you have these requirements installed:
@@ -35,7 +32,6 @@ Make sure, you have these requirements installed:
3532
On OSX you need `gnu-tar` instead of tar (GNU tar supports the `--transform` option).
3633
Please install it with e.g. `brew install gnu-tar`.
3734

38-
3935
## Development installation
4036

4137
The following commands will generate a `bundle.min.js` file in the `dist` directory
@@ -51,24 +47,22 @@ To start the development server, use `make serve` or `npx yarn start` and access
5147
The files are watched and the bundle re-built on changes.
5248
You can access the bundle directly at [http://localhost:3001/bundle.min.js](http://localhost:3001/bundle.min.js).
5349

54-
5550
## Layout
5651

5752
The individual patterns are located in their own folders in `./src/pat/`.
5853

5954
Each pattern folder contains some or all of the following files:
6055

61-
- _index.html_ which contains HTML markup that shows a demonstration of the pattern.
62-
- _documentation.md_ which is a Markdown file that documents the pattern's purpose, how to use it and how to configure it.
63-
- A javascript file which implements the pattern's functionality.
64-
- A Sass (.scss) file which provides the CSS associated with the pattern.
56+
- _index.html_ which contains HTML markup that shows a demonstration of the pattern.
57+
- _documentation.md_ which is a Markdown file that documents the pattern's purpose, how to use it and how to configure it.
58+
- A javascript file which implements the pattern's functionality.
59+
- A Sass (.scss) file which provides the CSS associated with the pattern.
6560

6661
To generate CSS files from the pattern's included Sass files, type `make all_css`
6762
and the css files will be generated in the same location as the Sass files.
6863

6964
You'll need to have a Sass compiler installed.
7065

71-
7266
## How to demo patterns
7367

7468
To demo the patterns, simply type `make serve` to install the necessary
@@ -80,7 +74,6 @@ Alternatively, patterns can also be demoed through the
8074
[Patternslib.com](http://patternslib.com) website, which is open-source. The
8175
code and setup instructions are [here](https://github.com/patternslib/Patterns-site).
8276

83-
8477
## Contributing fixes
8578

8679
To develop on Patterns, clone the repository and set it's push-url to your fork:
@@ -96,7 +89,6 @@ a url to your external repository.
9689

9790
Please read our [contribution notes](CONTRIBUTING.md) and read our [code style guide](docs/developer/styleguide.md).
9891

99-
10092
### Running tests
10193

10294
The simplest way to run the tests are to use make:
@@ -105,7 +97,6 @@ The simplest way to run the tests are to use make:
10597

10698
This will install all required npm and bower packages and run the tests.
10799

108-
109100
### Debugging tests
110101

111102
Eventually add to tests:
@@ -125,7 +116,6 @@ You can pass Jest any parameter it accepts, like `-t TESTPATTERN`::
125116

126117
node --inspect-brk node_modules/.bin/jest --runInBand ./src/pat/tooltip/tooltip.test.js -t will.be.closed.when
127118

128-
129119
### Enabling log messages
130120

131121
To facilitate debugging you can change the default log level through the URL query string by adding `loglevel` options.
@@ -139,13 +129,13 @@ To facilitate debugging you can change the default log level through the URL que
139129
There are some global variables that are available and can be used to make
140130
global settings or access otherwise hidden objects.
141131

142-
| Global variable | Purpose | Default |
143-
| --------------- | ------- | ------ |
144-
| window.__patternslib_import_styles | Whether to import pattern-specific styles | false |
145-
| window.__patternslib_patterns_blacklist | A list of patterns that should not be loaded. | [] |
146-
| window.__patternslib_registry | Global access to the Patternslib registry object. | - |
147-
| window.__patternslib_registry_initialized | True, if the registry has been initialized. | false |
148-
| window.__patternslib_disable_modernizr (Deprecated) | Disable modernizr, but still write the js/no-js classes to the body. | undefined |
132+
| Global variable | Purpose | Default |
133+
| ----------------------------------------------------- | -------------------------------------------------------------------- | --------- |
134+
| window.\_\_patternslib_import_styles | Whether to import pattern-specific styles | false |
135+
| window.\_\_patternslib_patterns_blacklist | A list of patterns that should not be loaded. | [] |
136+
| window.\_\_patternslib_registry | Global access to the Patternslib registry object. | - |
137+
| window.\_\_patternslib_registry_initialized | True, if the registry has been initialized. | false |
138+
| window.\_\_patternslib_disable_modernizr (Deprecated) | Disable modernizr, but still write the js/no-js classes to the body. | undefined |
149139

150140
### Bundle build analyzation
151141

@@ -166,17 +156,14 @@ https://www.npmjs.com/package/webpack-bundle-analyzer
166156

167157
webpack-bundle-analyzer stats.json
168158

169-
170159
### Organisations and projects which use Patternslib
171160

172-
- [Overstroom ik?](http://www.overstroomik.nl), a website which informs Dutch citizens of their risk of flooding. It was introduced and highly praised by the Dutch minister of infrastructure and environment, Melanie Schultz.
173-
- [OiRA](https://client.oiraproject.eu/), an online risk assessment tool, created for the Occupational Health and Safety Agency (OSHA) of the European Union.
174-
- [Staralliance](https://www.staralliance.com) uses Patternslib in their intranet.
175-
- [Plone](https://plone.com) CMS via [Mockup](https://github.com/plone/mockup/), which is built upon Patternslib.
176-
- [Quaive Intranet](https://quaivecloud.com/) uses Patternslib.
177-
161+
- [Overstroom ik?](http://www.overstroomik.nl), a website which informs Dutch citizens of their risk of flooding. It was introduced and highly praised by the Dutch minister of infrastructure and environment, Melanie Schultz.
162+
- [OiRA](https://client.oiraproject.eu/), an online risk assessment tool, created for the Occupational Health and Safety Agency (OSHA) of the European Union.
163+
- [Staralliance](https://www.staralliance.com) uses Patternslib in their intranet.
164+
- [Plone](https://plone.com) CMS via [Mockup](https://github.com/plone/mockup/), which is built upon Patternslib.
165+
- [Quaive Intranet](https://quaivecloud.com/) uses Patternslib.
178166

179167
### Interactive HTML/CSS prototypes made with Patternslib
180168

181-
- The [Patternslib.com](http://patternslib.com) website uses Patternslib and is based upon a prototype, which can be found [here](https://github.com/patternslib/Patterns-site).
182-
169+
- The [Patternslib.com](http://patternslib.com) website uses Patternslib and is based upon a prototype, which can be found [here](https://github.com/patternslib/Patterns-site).

0 commit comments

Comments
 (0)