Patternlibrary

About

Patternlibrary (@ npm: node-patternlibrary) is a pattern/component documentation and static site generator for use with Node-JS.

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.

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.

The template engine used is Handlebars and rendering markdown is accomplished with MarkdownIt. Parsing the style and script source files is utilizing (SassDoc) and (JSDoc).

Live-Demo

A live demonstration of a Patternlibrary GUI build can be found at demo.patternlibrary.net

Documentation

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

• Installation and (basic) usage

• Options

• Generating pattern documentation

  To generate the pattern-specific documentation pages, some requirements must be satisfied for each pattern:

  • the Pattern specifications

  Optionally, you can also apply...

  • SASS reference documentation,

  • JavaScript reference documentation,

  • a changelog.md file and

  • Test files and testing

• Building static pages

• GUI usage

• API documentation and advanced usage

• Gulp/Grunt middleware usage

Example project

An example front-end/theme project can be found in our GitLab.

Work-In-Progress disclaimer

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.

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

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.

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.

Please, see the license file for more information.