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.
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.
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) which itself is extended by Zurb Foundation's Panini (-> GitHub). The style and script source files are parsed by Zurb Foundation's Supercollider (-> GitHub) utilizing SassDoc (-> homepage) and JSDoc (-> homepage).
For detailed explanations of each of the parts that made up Patternlibrary, please see the following pages:
To generate the pattern-specific documentation pages, some requirements must be satisfied for each pattern:
Optionally, you can also apply...
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.