{"_id":"@antoine_a17/a17-node-sassdown","_rev":"11-4597e2b9811d20b6879d0c12f03a1c96","name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","dist-tags":{"latest":"1.0.7"},"versions":{"1.0.1":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.1","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"fs-extra":"2.0.0","node-sass":"4.4.0","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"5523d781c036da907016f00fa76ecf6560a9e9ce","_id":"@antoine_a17/a17-node-sassdown@1.0.1","scripts":{},"_shasum":"7a17fcbd35160a1d7ace1a2712c17a99faca4b77","_from":".","_npmVersion":"3.10.5","_nodeVersion":"4.1.2","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"shasum":"7a17fcbd35160a1d7ace1a2712c17a99faca4b77","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.1.tgz","integrity":"sha512-XwJDlJXflsoZRWl22CdKdHQ/FbfPHJNaYsWQQ/ngyBho14pCi/MF5JQCd/Rx4j7dorh1+cS/7h0Fu9njmzx96Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCW6BW/msDY5GE5eJTTO7j+sgLTdIHkzWV5/RUPX0hZ+wIgXQHo97jp0bJB/52EsKvxPf3q2oLBFpCv3jEJ/hTWA2c="}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/a17-node-sassdown-1.0.1.tgz_1494433122369_0.014575276989489794"}},"1.0.2":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.2","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"fs-extra":"2.0.0","node-sass":"4.4.0","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"3cfa8a25d7e6f70afd061a80b1ccd487307da988","_id":"@antoine_a17/a17-node-sassdown@1.0.2","scripts":{},"_shasum":"6649d4439f99139fce3d6660856110d31a718799","_from":".","_npmVersion":"3.10.5","_nodeVersion":"4.1.2","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"shasum":"6649d4439f99139fce3d6660856110d31a718799","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.2.tgz","integrity":"sha512-W3iroVBi9NRFIQfAnbtLjJ+DWIAT9C7ETPqcq6Jb7Zf2G2ewgOSFfdah+MwaAHHuhLtQI9iBnp3aHQzUNyMJkA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICd3DE73PFen7N6oGKshgXxS5cchAC1Z09uajo+qGNJZAiBc4o+qwbcAhISubXtE+2Eeb+eHAt4Q4wHpsi0NkWJcCQ=="}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/a17-node-sassdown-1.0.2.tgz_1494492574285_0.4597409216221422"}},"1.0.3":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.3","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"minimist":"^1.1.3","fs-extra":"2.0.0","node-sass":"4.4.0","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"3f71688f6bdd60aae22fe19a6c97f28a55954bae","_id":"@antoine_a17/a17-node-sassdown@1.0.3","_npmVersion":"5.0.3","_nodeVersion":"4.1.2","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"integrity":"sha512-cV7vnFFfjyxUfk8HtJNZ+sydECmqmGwuzNa+94Jjry5JyAf/PEPA4BRagJJ6xQn8I9z6CQo8H08KiMSOwQhzWQ==","shasum":"9fbc45cf0a9b5586467e78a73ef05d802ce97035","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.3.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD0zMbT7wJVvJRbAuVgpbl7bGTVauO3rgAMafu3c5xy2AIhAI2jZFg9uQZtxXIYekbfYw1rEydS1OxgkJXPgJuARD1c"}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a17-node-sassdown-1.0.3.tgz_1499076542910_0.33885418670251966"}},"1.0.4":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.4","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"minimist":"^1.1.3","fs-extra":"2.0.0","node-sass":"4.4.0","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"ce86dbce5b6a0f655b8b3971f417ebba13308b6b","_id":"@antoine_a17/a17-node-sassdown@1.0.4","_npmVersion":"5.0.3","_nodeVersion":"4.1.2","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"integrity":"sha512-9h4G7VXaje2RZb+GKIZKiQ23eKS5BYfilsdqXA02GWMCpDgodNEWCOb6GJdgB9WfR3bVBetCQ0BwVk5o/JtZ7Q==","shasum":"b330f645d73386affb048b3f0f3b738ef7466962","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.4.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAsuu0IxDU6zJW8SodmKzznTJtr5Wl1mw/8EFFH+WebQAiEApcl/iLMRYFF1ZkFC43/IR9BiZm8eQV8uCTWqFQfugCk="}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a17-node-sassdown-1.0.4.tgz_1499085381197_0.7618451695889235"}},"1.0.5":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.5","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"minimist":"^1.1.3","fs-extra":"2.0.0","node-sass":"4.4.0","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"a581e416d983b1e4aad8a8ec2db4c4b6c814f27b","_id":"@antoine_a17/a17-node-sassdown@1.0.5","_npmVersion":"5.0.3","_nodeVersion":"4.1.2","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"integrity":"sha512-PdI7XB+//pvWqUkp3y6sz780FH4Bec+WPpOtJhL8tUc/6sRppdY6Hf+CfNfoucYkNo9uWfZeeH6zRKYTcw5+/Q==","shasum":"ef869cb4bc4c95dbf99682cfbf5de2219b24b036","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.5.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD+PQ7rOWJTfcLmpotO8MDKDFveoi+/8fwBIHxzxFAshwIhANAA0ioG6OokxR9V4AbqqGey9RnJt0S0ZmLmcmFTdPUS"}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a17-node-sassdown-1.0.5.tgz_1499343383619_0.39338582940399647"}},"1.0.6":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.6","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"minimist":"^1.1.3","fs-extra":"2.0.0","node-sass":"4.4.0","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"8ff26445b0ce3c5bd556320747239b6cc2c7fd24","_id":"@antoine_a17/a17-node-sassdown@1.0.6","_npmVersion":"5.0.4","_nodeVersion":"8.1.0","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"integrity":"sha512-fqmcbG+fT3dSsh8pcqVDXsXhGiyvUTlcNUuNRnMq44jIiGpnn2RlkMCo0krRscv7wePl6DNFBZqWfv+wimHiww==","shasum":"c77d1703b9bb36eb799dfd323bf9391ebe626210","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.6.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHP3eUkhcz4zZK/f645YMi/z4Jos46JSF6CrZmfc0ZVnAiEA0qJBFwTWIpoUIUO7xbC+7ukniJYnsHJW6jQO0jwd0aE="}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a17-node-sassdown-1.0.6.tgz_1501507815218_0.35323666874319315"}},"1.0.7":{"name":"@antoine_a17/a17-node-sassdown","description":"Node tool for building living styleguides with Handlebars from Markdown comments in CSS, Sass and LESS files. Ported from node-sassdown.","version":"1.0.7","author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"licenses":[{"type":"Creative Commons","url":"http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"}],"main":"lib/sassdown.js","engines":{"node":"~0.12.0"},"devDependencies":{"gulp":"^3.9.1","del":"^2.2.2"},"dependencies":{"minimist":"^1.1.3","fs-extra":"2.0.0","node-sass":"4.6.1","uglify-js":"2.7.5","cssmin":"0.4.3","glob":"5.0.15","handlebars":"4.0.3","highlight.js":"9.9.0","html-entities":"1.1.3","junk":"1.0.2","lodash":"3.10.1","marked":"0.3.6","js-yaml":"3.7.0"},"gitHead":"63ff799945e11918b7fd5d9773f384a4c461c5fa","_id":"@antoine_a17/a17-node-sassdown@1.0.7","_npmVersion":"5.5.1","_nodeVersion":"8.6.0","_npmUser":{"name":"antoine_a17","email":"antoine@area17.com"},"dist":{"integrity":"sha512-UtcONn7WuKP5RBVdaq+hmVqN2FzISOMz+uj9OvZJq064EzAYzcdxz5JmKE5mry+JYXvM8jwfYqxV+DnbzxUDNw==","shasum":"19e87c462cb478e8df52183aed9c3276ccd1a587","tarball":"https://registry.npmjs.org/@antoine_a17/a17-node-sassdown/-/a17-node-sassdown-1.0.7.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC+53aSWoZ4K7xBhfPaOc0pHsWhHnNXSMI+pjjEpcknvgIgBVJwjorjiYrstSsZcwgPl4454LbIoC8PczvYxby6Pr8="}]},"maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a17-node-sassdown-1.0.7.tgz_1510753920479_0.9399927351623774"}}},"readme":"# node-sassdown\n\nNode library for building living styleguides with Handlebars from Markdown files and Markdown comments in CSS or Sass files.\n\n**Note: This library is highly inspired by [node-sassdown](https://github.com/fevrcoding/node-sassdown) which itself is based on sassdown version `0.2.7` by Jesper Hills.**\n\nThis version is introducing the following new features : \n\n- Add a powerful default theme based on the UI of [AREA17 Guides](https://guides.area17.com/design-techniques/)\n- Adding configuration options to change orders of sections and subsections and customize titles.\n  Create a yml file with the same name, see [_grid.scss.yml](https://code.area17.com/a17/node-sassdown/blob/master/test/example/scss/layout/_grid.scss.yml) for example.\n- Generate single page or page based toolkits.\n  Check [options.singlePage](#optionssinglepage) for usage\n- You can add introduction/index to any folders. \n  See [index.md](https://code.area17.com/a17/node-sassdown/blob/master/test/example/scss/modules/index.md) for example.\n- Move away from grunt\n\n# Documentation\n\n1. [Getting started](#getting-started)\n2. [Usage](#usage)\n    - [Options](#options)\n    - [Arguments](#arguments)\n3. [Markdown](#markdown)\n4. [Handlebars](#handlebars)\n5. [Highlight.js](#highlightjs)\n6. [Data Objects](#data-objects)\n    - [Page](#page)\n    - [Pages](#pages)\n7. [Template](#template)\n8. [Sass](#sass)\n\n## Getting started\n\nInstall this library with this command:\n\n```bash\nnpm install @antoine_a17/a17-node-sassdown\n```\n\n## Usage\n\nImport the library in your file and initialize it \n\n```js\nvar sassdown = require('@antoine_a17/a17-node-sassdown');\n\nvar srcPath = 'assets/scss';\nvar destPath = 'styleguide';\nvar options = {};\n\n//generate styleguide\nsassdown(srcPath, destPath, options);\n```\n\n\n### Arguments\n\n#### srcGlob\nType: `String|Array`<br/>\nDefault: `null`\n\nA [glob](https://github.com/isaacs/node-glob) path or an array of filepaths\n \n#### srcPath\nType: `String`<br/>\nDefault: `null`\n\nRoot folder of source files (used as `cwd` [option](https://github.com/isaacs/node-glob#options) in glob )\n\n#### destPath\nType: `String`<br/>\nDefault: `null`\n\nRoot folder of generated styleguide\n\n#### options\nType: `Object`<br/>\nDefault: `{}`\n\nStyleguide options. See below for details\n\n### Options\n\n#### options.assets\nType: `Array`<br/>\nDefault: `null`\n\n*Optional*. Array of file paths. Will be included into the styleguide output. Supports [globbing](https://github.com/isaacs/node-glob). Supports relative and absolute file paths (eg. `http://`, `https://`, `//` or even `file://`).\n\n#### options.template\nType: `String`<br/>\nDefault: `null`\n\n*Optional*. A path to a Handlebars template file. Will use default Sassdown template if left blank.\n\n#### options.handlebarsHelpers\nType: `Array`<br/>\nDefault: `null`\n\n*Optional*. Array of file paths. The [Handlebars helpers](http://handlebarsjs.com/#helpers) will be available to use in the template. Supports [globbing](https://github.com/isaacs/node-glob). Supports relative and absolute file paths (eg. `http://`, `https://` or even `file://`).\n\n#### options.theme\nType: `String`<br/>\nDefault: `null`\n\n*Optional*. A path to a theme folder (containing JS/CSS/fonts/images files). Will use default Sassdown theme based on guides.area17.com UI if left blank.\n\n#### options.readme\nType: `String`<br/>\nDefault: `null`\n\n*Optional*. Path to a README file. When set, this file will be parsed with Markdown and used as the index page for the styleguide.\n\n#### options.highlight\nType: `String`<br/>\nDefault: `github`\n\n*Optional*. Choice of syntax highlighting style. Defaults to `github`, but other available options are: `docco`, `monokai`, `solarized-light`, `solarized-dark` or `xcode`.\n\n#### options.commentStart\nType: `RegExp`<br/>\nDefault: `/\\/\\*/`\n\n*Optional*. A regular expression to match beginning part of a comment block. Defaults to regular block comment (`/*`).\n\n#### options.commentEnd\nType: `RegExp`<br/>\nDefault: `/\\*\\//`\n\n*Optional*. A regular expression to match ending part of a comment block. Defaults to regular block comment (`*/`).\n\n#### options.excludeMissing\nType: `Boolean`<br/>\nDefault: `true`\n\n*Optional*. When set to true, Sassdown will ignore any files that do not contain matching or valid comment blocks.\n\n#### options.dryRun\nType: `Boolean`<br/>\nDefault: `false`\n\n*Optional*. When set to true, Sassdown will not generate any files, and will exit with status `1` if any files do not contain matching or valid comment blocks.\n\n#### options.singlePage\nType: `Boolean`<br/>\nDefault: `true`\n\n*Optional*. When set to true, Sassdown will only generate an index file. This is useful when you use a theme that is a one-page documentation.\n\n# Markdown\n\nSassdown uses [Markdown](https://github.com/chjj/marked) to parse any block comments in your Sass files. From these, it generates the text content in the styleguide. Any recognised code blocks will be rendered as HTML/SCSS source-result pairs.\n\n## Structure\n\nYou may use any Markdown-compatible [heading syntax](https://github.com/nopr/sassdown/issues/7) you like. You may use any common style of [block-comment syntax](https://github.com/nopr/sassdown/issues/12#issuecomment-28219982) you like. Code blocks may be fenced or indented (four spaces or one tab character). Below are several examples; each will be correctly parsed by Sassdown into identical output.\n\n### Example .scss file\n\n```scss\n/*\n\nAlerts\n======\n\nCreates an alert box notification using the `.alert-` prefix. The following options are available:\n\n    <div class=\"alert-success\">Success</div> \n    <div class=\"alert-warning\">Warning</div> \n    <div class=\"alert-error\">Error</div>\n\n*/\n@mixin alert($colour){\n    color: darken($colour, 50%);\n    background: $colour;\n    border-radius: 5px;\n    margin-bottom: 1em;\n    padding: 1em;\n}\n.alert-success { @include alert(#e2f3c1) }\n.alert-warning { @include alert(#fceabe) }\n.alert-error   { @include alert(#ffdcdc) }\n```\n\n# Handlebars\n\n[Handlebars](http://handlebarsjs.com/) is a semantic templating syntax. Put simply, it allows you to output dynamic properties in HTML using `{{var}}` from a variety of data sources such as JSON.\n\nSassdown uses Handlebars to output data from the [data objects](#data-objects) it creates. Your `.hbs` file specified in the `template` option may contain code that looks like this for example:\n\n```html\n{{#each page.sections}}\n    <div class=\"section\">\n        {{#if comment}}\n            <div class=\"comment\">{{{comment}}}</div>\n        {{/if}}\n        {{#if result}}\n            <div class=\"result\">{{{result}}}</div>\n        {{/if}}\n        {{#if markup}}\n            <div class=\"markup\">{{{markup}}}</div>\n        {{/if}}\n        {{#if styles}}\n            <div class=\"styles\">{{{styles}}}</div>\n        {{/if}}\n    </div>\n{{/each}}\n```\n\n### Common partials\n\nSassdown also provides a series of Handlebars **partials**, which can be used to output specific information on each page. These are:\n\n* `{{> root}}`<br>Outputs a path to the root directory of the styleguide, relative to whatever page you are on.\n \n* `{{> assets}}`<br>Outputs a set of `<link />` or `<script>` tags that include assets specified in the Grunt task options.\n\n\n### Handlebars helpers\n\nYou can add more features to Handlebar templates by using [Helpers](http://handlebarsjs.com/#helpers).\n\nFor example you could add a helper that capitalizes all text:\n\n    <big>{{uppercase shoutThis}}</big>\n    \nYou load your helpers with the `handlebarsHelpers` option.\n\n    handlebarsHelpers: ['hb-helpers/**/*.js']\n\nThe helper module must export a function that does the registration, or else it won't load.\n\n    module.exports = function(Handlebars) {\n        Handlebars.registerHelper('uppercase', function(input) {\n          return typeof input === 'string' ? input.toUpperCase() : input;\n        });\n    };\n    \n    // This also works\n    module.exports = {\n      register: function(Handlebars) {\n        ...\n    }\n\nThe following helpers are already included by default :\n\n- capitalize\n- lowercase\n- strip_num (Remove numbers that are at the beginning of words) \n- titlecase\n- urlify (turn text into valid url strings)\n\n# Highlight.js\n\nSassdown uses the popular and well-supported [Highlight.js](http://highlightjs.org/) for syntax highlighting. Markup is parsed by a Node module and highlighted before being output through the template. Various popular themes are supported via the task options.\n\n# Data Objects\n\nTwo objects are parsed into the Handlebars template; `Page` and `Pages`. **Page** contains json data for the current page only; **Pages** is an array literal containing all Page objects in a nested node tree.\n\nAny property within these objects can be output by Handlebars using `{{helpers}}`. You can iterate through objects using `{{#each}} ... {{/each}}`, for example.\n\n## Page\n\n```js\n{\n  title: 'Alerts',\n  slug: '_alerts',\n  href: 'objects/user/_alerts.html',\n  dest: 'test/example/styleguide/objects/user/_alerts.html',\n  src: 'test/example/assets/sass/partials/objects/user/_alerts.scss',\n  position: 0,\n  sections: [ \n    {\n      id: 'mswbu',\n      comment: '<h1 id=\"alerts\">Alerts</h1>\\n<p>Creates an alert box notification using the <code>.alert-</code> prefix. The following options are available:</p>\\n',\n      result: '\\n<div class=\"alert-success\">Success</div> \\n<div class=\"alert-warning\">Warning</div> \\n<div class=\"alert-error\">Error</div>\\n',\n      markup: '<pre><code><span class=\"token tag\" ><span class=\"token tag\" ><span class=\"token punctuation\" >&lt;</span>div</span> <span class=\"token attr-name\" >class</span><span class=\"token attr-value\" ><span class=\"token punctuation\" >=</span>&quot;alert-success&quot;&gt;</span></span>Success<span class=\"token tag\" ><span class=\"token tag\" ><span class=\"token punctuation\" >&lt;/</span>div</span><span class=\"token punctuation\" >&gt;</span></span> \\n<span class=\"token tag\" ><span class=\"token tag\" ><span class=\"token punctuation\" >&lt;</span>div</span> <span class=\"token attr-name\" >class</span><span class=\"token attr-value\" ><span class=\"token punctuation\" >=</span>&quot;alert-warning&quot;&gt;</span></span>Warning<span class=\"token tag\" ><span class=\"token tag\" ><span class=\"token punctuation\" >&lt;/</span>div</span><span class=\"token punctuation\" >&gt;</span></span> \\n<span class=\"token tag\" ><span class=\"token tag\" ><span class=\"token punctuation\" >&lt;</span>div</span> <span class=\"token attr-name\" >class</span><span class=\"token attr-value\" ><span class=\"token punctuation\" >=</span>&quot;alert-error&quot;&gt;</span></span>Error<span class=\"token tag\" ><span class=\"token tag\" ><span class=\"token punctuation\" >&lt;/</span>div</span><span class=\"token punctuation\" >&gt;</span></span></code></pre>\\n',\n      styles: '<pre><code><span class=\"token keyword\" >@mixin</span> alert(<span class=\"token variable\" >$colour</span>)<span class=\"token punctuation\" >{</span>\\n    <span class=\"token property\" >color</span><span class=\"token punctuation\" >:</span> darken(<span class=\"token variable\" >$colour</span>, 50%)<span class=\"token punctuation\" >;</span>\\n    <span class=\"token property\" >background</span><span class=\"token punctuation\" >:</span> <span class=\"token variable\" >$colour</span><span class=\"token punctuation\" >;</span>\\n    <span class=\"token property\" >border-radius</span><span class=\"token punctuation\" >:</span> 5px<span class=\"token punctuation\" >;</span>\\n    <span class=\"token property\" >margin-bottom</span><span class=\"token punctuation\" >:</span> 1em<span class=\"token punctuation\" >;</span>\\n    <span class=\"token property\" >padding</span><span class=\"token punctuation\" >:</span> 1em<span class=\"token punctuation\" >;</span>\\n<span class=\"token punctuation\" >}</span>\\n\\n.alert-success <span class=\"token punctuation\" >{</span> <span class=\"token keyword\" >@include</span> alert(#e2f3c1) <span class=\"token punctuation\" >}</span>\\n.alert-warning <span class=\"token punctuation\" >{</span> <span class=\"token keyword\" >@include</span> alert(#fceabe) <span class=\"token punctuation\" >}</span>\\n.alert-error   <span class=\"token punctuation\" >{</span> <span class=\"token keyword\" >@include</span> alert(#ffdcdc) <span class=\"token punctuation\" >}</span></code></pre>\\n'\n    }\n  ]\n}\n```\n\n## Pages\n\n```js\n[\n  {\n    name: 'base',\n    title: 'base',\n    isDirectory: true,\n    pages: [\n      [Object],\n      {\n        name: 'typography',\n        isDirectory: true,\n        pages: [\n          [Object],\n          [Object],\n          [Object]\n        ]\n      },\n      [Object],\n      [Object]\n    ]\n  },\n  {\n    name: 'partials',\n    isDirectory: true,\n    pages: [\n      [Object],\n      [Object]\n    ]\n  },\n  {\n    name: 'modules',\n    isDirectory: true,\n    pages: [\n      [Object] \n    ]\n  },\n  {\n    name: 'objects',\n    isDirectory: true,\n    pages: [\n      [Object],\n      [Object], \n      [Object]\n    ]\n  }\n]\n```\n\n# Template\n\n*Single Page*\nIf you want to customize the default template, you may wish to use the [existing default template.hbs](https://code.area17.com/a17/node-sassdown/blob/master/lib/a17-theme/template.hbs) as a base to work from. \n\n*Multiple Page*\nIf you don't want to use a single page templates : you can the [existing default template_multipage.hbs](https://code.area17.com/a17/node-sassdown/blob/master/lib/a17-theme/template_multipage.hbs) as a base.\n\nThe default multiple page theme is using pjax to refresh page (with Barba.js).\n\n# Sass\n\nIt should be noted that, despite the name, Sassdown does not explicitly read only Sass files. It works just fine with .sass, .less, .css or even .txt files.\n\nSassdown **does not** compile your source files.\n","maintainers":[{"name":"antoine_a17","email":"antoine@area17.com"}],"time":{"modified":"2022-06-12T14:43:01.156Z","created":"2017-05-10T16:18:43.440Z","1.0.1":"2017-05-10T16:18:43.440Z","1.0.2":"2017-05-11T08:49:35.413Z","1.0.3":"2017-07-03T10:09:04.571Z","1.0.4":"2017-07-03T12:36:23.030Z","1.0.5":"2017-07-06T12:16:25.251Z","1.0.6":"2017-07-31T13:30:17.025Z","1.0.7":"2017-11-15T13:52:02.291Z"},"homepage":"https://code.area17.com/a17/node-sassdown","repository":{"type":"git","url":"git+ssh://git@code.area17.com/a17/node-sassdown.git"},"contributors":[{"name":"Marco Solazzi","email":"marco.solazzi@gmail.com","url":"http://www.fevr.it"},{"name":"Jesper Hills","email":"jay@nopr.co","url":"http://www.nopr.co"}],"author":{"name":"Doury Antoine","email":"antoine@area17.com","url":"http://area17.com"},"bugs":{"url":"https://code.area17.com/a17/node-sassdown/issues"},"readmeFilename":"README.md"}