Commit 24747723 authored by Björn Bartels's avatar Björn Bartels

PATLAB-5 update intro text

parent 7e669a90
Pipeline #76 passed with stage
in 3 minutes and 47 seconds
# **Patternlibrary**
......@@ -14,27 +15,42 @@
## Welcome to the self-documenting demo
## Welcome to the **Patternlibrary** demo
**Patternlibrary** (@ npm: _node-patternlibrary_) is a static site and pattern/component documentation generator for use with Node, Gulp or Grunt.
It compiles a series of HTML **patterns**, or _partials_, or _components_, structured in an **atomic desing pattern**. These patterns can also include other **patterns**, external Handlebars **helpers**, or external **data** as JSON or YAML.
**Patternlibrary** (@ npm: _node-patternlibrary_) is a pattern/component documentation and static site generator for use with Node-JS.
Documentation pages for each pattern are created according to the specific pattern meta-data supplied. Those pages are combined under a GUI to view in your browser.
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.
The GUI provides an overview dashboard, lists to browse patterns and categories and (kind of) interactive pattern documentation.
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*](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)).
### 3,... 2,... 1...
The main **Patternlibrary** GUI entrance page is
> [**The Dashboard**](./pl/)
which can also be accessed by clicking the \[title/logo\] in the upper left corner.
It may be appropriate, but it is not mandatory, to put an introductory page like this up on the front of the pattern-library for a possible consumer, maybe a plugin or an application's (micro)service developer, to get to know what she/he is going to find here and/or what that project is about.
## Documentation
For detailed explanations on how to use **Patternlibrary**, please see the browse the [help pages](./pl/help/docs/).
[**The help pages**](./pl/help/docs/) provide detailed explanations on how to install and use **Patternlibrary**.
......@@ -52,10 +68,8 @@ For detailed explanations on how to use **Patternlibrary**, please see the brows
### Work-In-Progress disclaimer
This project is now going from some kind of *Proof Of Concept* to real implementation.
Most of its features and behavour is fixed so far.
DO NOT USE IN PRODUCTION ENVIRONMENTS YET!
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.
......
......@@ -21,13 +21,13 @@ layout: patternlibrary
## About
**Patternlibrary** (@ npm: _node-patternlibrary_) is a static site and pattern/component documentation generator for use with Node, Gulp or Grunt.
**Patternlibrary** (@ npm: _node-patternlibrary_) is a pattern/component documentation and static site generator for use with Node-JS.
It compiles a series of HTML **patterns**, or _partials_, or _components_, structured in an **atomic desing pattern**. These patterns can also include other **patterns**, external Handlebars **helpers**, or external **data** as JSON or YAML.
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.
Documentation pages for each pattern are created according to the specific pattern meta-data supplied. Those pages are combined under a GUI to view in your browser.
The GUI provides an overview dashboard, lists to browse patterns and categories and (kind of) interactive pattern documentation.
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*](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)).
......@@ -84,10 +84,8 @@ For detailed explanations of each of the parts that made up **Patternlibrary**,
### Work-In-Progress disclaimer
This project is now going from some kind of *Proof Of Concept* to real implementation.
Most of its features and behavour is fixed so far.
DO NOT USE IN PRODUCTION ENVIRONMENTS YET!
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.
......
......@@ -13,27 +13,28 @@ layout: patternlibrary
[![Build Status](https://travis-ci.org/bb-drummer/node-patternlibrary.svg?branch=master)](https://travis-ci.org/bb-drummer/node-patternlibrary)
### Work-In-Progress disclaimer
This project is now still a work in progress!
Some of its features and options are or may be a subject to change!
---
DO NOT USE IN PRODUCTION ENVIRONMENTS !
When using this software, absolutely no warranties of any sort are granted. Please see the license file for more information.
## About
---
## 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*](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)).
**Patternlibrary** (a.k.a. _node-patternlibrary_) is a simple flat file documentaion generator for use with Node, Gulp or Grunt.
It compiles a series of HTML **patterns** (a.k.a. _partials_) structured in an **atomic desing pattern**. These patterns can also include other HTML **patterns**/**partials**, external Handlebars **helpers**, or external **data** as JSON or YAML.
## Live-Demo
Documentation pages for each pattern are created according to the specific pattern meta-data supplied. Those pages are combined under a GUI to view in your browser.
The main template engine behind this is *handlebars* ([-> homepage](http://handlebarsjs.com)) which itself is extended by *Zurb Foundation*'s *Panini* ([-> GitHub](https://github.com/zurb/panini)). The style and script source files are parsed by *Zurb Foundation*'s *Supercollider* ([-> GitHub](https://github.com/zurb/supercollider)) utilizing *SassDoc* ([-> homepage](http://sassdoc.com/)) and *JSDoc* ([-> homepage](http://usejsdoc.org)).
A live demonstration of a **Patternlibrary** GUI build can be found at [demo.patternlibrary.net](https://demo.patternlibrary.net)
## Documentation
......@@ -78,8 +79,21 @@ For detailed explanations of each of the parts that made up **Patternlibrary**,
[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).
---
### 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:
......
......@@ -18,18 +18,27 @@
**Patternlibrary** (@ npm: _node-patternlibrary_) is a static site and pattern/component documentation generator for use with Node, Gulp or Grunt.
**Patternlibrary** (@ npm: _node-patternlibrary_) is a pattern/component documentation and static site generator for use with Node-JS.
It compiles a series of HTML **patterns**, or _partials_, or _components_, structured in an **atomic desing pattern**. These patterns can also include other **patterns**, external Handlebars **helpers**, or external **data** as JSON or YAML.
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.
Documentation pages for each pattern are created according to the specific pattern meta-data supplied. Those pages are combined under a GUI to view in your browser.
The GUI provides an overview dashboard, lists to browse patterns and categories and (kind of) interactive pattern documentation.
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*](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)).
## Live-Demo
A live demonstration of a **Patternlibrary** GUI build can be found at [demo.patternlibrary.net](https://demo.patternlibrary.net)
## Documentation
......@@ -81,10 +90,8 @@ For detailed explanations of each of the parts that made up **Patternlibrary**,
### Work-In-Progress disclaimer
This project is now going from some kind of *Proof Of Concept* to real implementation.
Most of its features and behavour is fixed so far.
DO NOT USE IN PRODUCTION ENVIRONMENTS YET!
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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment