readme.md 4.92 KB
Newer Older
Björn Bartels's avatar
Björn Bartels committed
1
# **Patternlibrary**
Björn Bartels's avatar
Björn Bartels committed
2

3 4


Björn Bartels's avatar
Björn Bartels committed
5 6 7 8 9
[![npm version](https://badge.fury.io/js/node-patternlibrary.svg)](https://badge.fury.io/js/node-patternlibrary "npm version")
[![dependencies status](https://david-dm.org/bb-drummer/node-patternlibrary.svg)](https://david-dm.org/bb-drummer/node-patternlibrary "dependencies status")
[![Scrutinizer-CI code quality score](https://scrutinizer-ci.com/g/bb-drummer/node-patternlibrary/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/bb-drummer/node-patternlibrary/?branch=master "Scrutinizer-CI code quality score")
[![Scrutinizer-CI build status](https://scrutinizer-ci.com/g/bb-drummer/node-patternlibrary/badges/build.png?b=master)](https://scrutinizer-ci.com/g/bb-drummer/node-patternlibrary/build-status/master "Scrutinizer-CI build status")
[![Travis-CI build status](https://travis-ci.org/bb-drummer/node-patternlibrary.svg?branch=master)](https://travis-ci.org/bb-drummer/node-patternlibrary "Travis-CI build status")
Björn Bartels's avatar
Björn Bartels committed
10 11


Björn Bartels's avatar
Björn Bartels committed
12

Björn Bartels's avatar
Björn Bartels committed
13
---
Björn Bartels's avatar
Björn Bartels committed
14 15 16



17
## About
Björn Bartels's avatar
Björn Bartels committed
18

Björn Bartels's avatar
Björn Bartels committed
19

Björn Bartels's avatar
Björn Bartels committed
20

21
**Patternlibrary** (@ npm: _node-patternlibrary_) is a pattern/component documentation and static site generator for use with Node-JS. 
Björn Bartels's avatar
Björn Bartels committed
22

23 24 25
It generates a series of documentation pages for each of the HTML **patterns**, or _partials_, or _components_, structured in an **atomic design pattern**.
Documentation details are assembled from the specific pattern-files's source codes and supplied meta-data. 
Of course, like any other (Handlebars) partial, those patterns can also include other patterns, external (Handlebars) helpers or data as JSON or YAML, by themselfs.
Björn Bartels's avatar
Björn Bartels committed
26

27
These pages are combined under a GUI to view in your browser. It provides an overview dashboard, lists to browse patterns and categories and (kind of) interactive pattern documentation.
Björn Bartels's avatar
Björn Bartels committed
28 29 30

The template engine used is [*Handlebars*](http://handlebarsjs.com) and rendering _markdown_ is accomplished with [*MarkdownIt*](https://github.com/markdown-it/markdown-it). Parsing the style and script source files is utilizing ([*SassDoc*](http://sassdoc.com/)) and ([*JSDoc*](http://usejsdoc.org)).

Björn Bartels's avatar
Björn Bartels committed
31

Björn Bartels's avatar
Björn Bartels committed
32

33 34 35 36 37 38 39 40 41

## Live-Demo



A live demonstration of a **Patternlibrary** GUI build can be found at [demo.patternlibrary.net](https://demo.patternlibrary.net)



42
## Documentation
Björn Bartels's avatar
Björn Bartels committed
43 44


Björn Bartels's avatar
Björn Bartels committed
45

46
For detailed explanations of each of the parts that made up **Patternlibrary**, please see the following pages:
47

Björn Bartels's avatar
Björn Bartels committed
48
- [Installation and (basic) usage](gui/src/pages/pl/help/docs/usage.md)
49

Björn Bartels's avatar
Björn Bartels committed
50
- [Options](gui/src/pages/pl/help/docs/options.md)
51

Björn Bartels's avatar
Björn Bartels committed
52
- [Generating pattern documentation](gui/src/pages/pl/help/docs/patternspecs.md)
53

Björn Bartels's avatar
Björn Bartels committed
54
  To generate the pattern-specific documentation pages, some requirements must be satisfied for each pattern:
55

Björn Bartels's avatar
Björn Bartels committed
56
  - the [Pattern specifications](gui/src/pages/pl/help/docs/patternspecs.md)
57 58 59 60
  
  
  Optionally, you can also apply...
  
Björn Bartels's avatar
Björn Bartels committed
61 62 63
  - [SASS reference documentation](gui/src/pages/pl/help/docs/sassdoc.md),
  
  - [JavaScript reference documentation](gui/src/pages/pl/help/docs/jsdoc.md),
64
  
Björn Bartels's avatar
Björn Bartels committed
65
  - a [`changelog.md` file](gui/src/pages/pl/help/docs/changelog.md) and
66
  
Björn Bartels's avatar
Björn Bartels committed
67
  - [Test files and testing](gui/src/pages/pl/help/docs/testing.md)
68
  
Björn Bartels's avatar
Björn Bartels committed
69
- [Building static pages](gui/src/pages/pl/help/docs/staticpages.md)
70
  
Björn Bartels's avatar
Björn Bartels committed
71
- [GUI usage](gui/src/pages/pl/help/docs/gui.md)
72
  
Björn Bartels's avatar
Björn Bartels committed
73
- [API documentation and advanced usage](gui/src/pages/pl/help/docs/api.md)
Björn Bartels's avatar
Björn Bartels committed
74
  
Björn Bartels's avatar
Björn Bartels committed
75
- [Gulp/Grunt middleware usage](gui/src/pages/pl/help/docs/middleware.md)
Björn Bartels's avatar
Björn Bartels committed
76 77


Björn Bartels's avatar
Björn Bartels committed
78 79 80

## Example project

Björn Bartels's avatar
Björn Bartels committed
81 82


Björn Bartels's avatar
Björn Bartels committed
83
[An example front-end/theme project](https://gitlab.bjoernbartels.earth//themes/node-patternlibrary-demo) can be found in our [GitLab](https://gitlab.bjoernbartels.earth//themes/node-patternlibrary-demo).
Björn Bartels's avatar
Björn Bartels committed
84

Björn Bartels's avatar
Björn Bartels committed
85 86 87 88 89 90 91 92


---



### Work-In-Progress disclaimer

93 94
This project is now going from some kind of *Proof Of Concept* to real-life implementation.
Most of its behavour and features are fixed for now.
Björn Bartels's avatar
Björn Bartels committed
95 96 97 98 99

When using this software, absolutely no warranties of any sort are granted. Please see the license file for more information.



Björn Bartels's avatar
Björn Bartels committed
100 101
---

Björn Bartels's avatar
Björn Bartels committed
102 103


Björn Bartels's avatar
Björn Bartels committed
104 105 106 107 108
Copyright (c) 2017, [bjoernbartels.earth]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
109

Björn Bartels's avatar
Björn Bartels committed
110
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
111

Björn Bartels's avatar
Björn Bartels committed
112
Please, see the license file for more information.
Björn Bartels's avatar
Björn Bartels committed
113 114 115 116 117 118


---