{"_id":"@deimosindustries/markdown-documentation-generator","_rev":"3-f2cba6326a05ec1a9affbf89f5870c94","name":"@deimosindustries/markdown-documentation-generator","dist-tags":{"latest":"3.2.5"},"versions":{"3.2.3":{"name":"@deimosindustries/markdown-documentation-generator","version":"3.2.3","description":"Searches files for markdown and generates a static style/documentation guide. A fork of markdown-styleguide-generator.","main":"index.js","scripts":{"test":"node test.js"},"repository":{"type":"git","url":"git+https://github.com/deimosindustries/markdown-documentation-generator.git"},"keywords":["markdown","style guide","pattern library","css","sass","documentation"],"author":{"name":"Luigi Mannoni","email":"luigi@deimosindustries.com"},"license":"GPL-3.0","bugs":{"url":"https://github.com/deimosindustries/markdown-documentation-generator/issues"},"homepage":"https://github.com/deimosindustries/markdown-documentation-generator#readme","engines":{"node":">= 4"},"dependencies":{"chalk":"^2.4.2","cheerio":"^0.22.0","fs-extra":"^8.0.1","handlebars":"^4.1.2","highlight.js":"^10.4.1","lodash":"^4.17.11","marked":"^0.7.0","walk":"^2.3.9","yargs":"^13.2.4"},"devDependencies":{"nodemon":"^1.19.1"},"bin":{"md_documentation":"index.js"},"gitHead":"88e3b6e08463a5feb076154634ad38bedcbc7d2c","_id":"@deimosindustries/markdown-documentation-generator@3.2.3","_nodeVersion":"14.4.0","_npmVersion":"7.6.0","dist":{"integrity":"sha512-kWIbCaYco85PVNAsiy4WrcG+ZiJVcY7qCwnEjrArgG9KBJ54MEtIq9x8v9WI/7qqPzQt5/KJ1vCCVKsxz0Qk5A==","shasum":"62309cca8a9e0348bce47e0ab29ca9a7ebce1e00","tarball":"https://registry.npmjs.org/@deimosindustries/markdown-documentation-generator/-/markdown-documentation-generator-3.2.3.tgz","fileCount":23,"unpackedSize":429601,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgf+NcCRA9TVsSAnZWagAAiuAP/2hBYKjlrFDZ8jJPxAYf\nsGc/5XePsEEOmgG5SPIzaQYcOzTMpGN6XNc8sSxFOQuH/9P8PJBAmL+PfzNX\nLxu1olTVe3YXGhXpO5ZaMbC2U60/MKTiVfZfl6mfeFKVxWYJBZvTFQ4o03qt\no5MsY1gb1VgKGtOxbYE3Rjl6ya7RCXwdKvxMAzywIMx2fKqVumfm9VbBuuDd\njALm77ZveLXFF4F8gsfscNI3xPULUVGeJPuh0+y+iD42RJpaARh9nI5FuTJS\nNqRqArpvD5e+STVeO58xXTmxDSnxneAAGnRglXTG5s+6KtiFoHfcqTTqOMH/\nRHF/EaD2siMwta1zcAT2+7Pf504eRQyTS4ox4ldea4R0tqz9MjpwLJ9gL5xu\n5gyCK146yjtO1hvUcF1W1pmp9mpcoMweOLAP5dqSV34mY7vDFEcul8Zwkbqu\na2TeIUFtsGs+HjOYfws5Q6j23XdLcGHkdwzTz6axmZgGeJxgTzN6YxY5m7Tj\n+2Dkyp2wYfnSuZ5Kewdjmgk9A5FLEY6hJTQ87XflSR4KgHWlt+vFVlbxAHad\n+ZTOEpekmIleESG98DwVA5nc2ViWaE8P6bj0kui9pTxi2/uP82FUMS+GDRbv\nwe1qdBvx/XPyhjNr2U5BLrFqM+gEqsG5ALU8m/66G3qWlE5KQLncNLxm3BWl\ngVCx\r\n=fjYK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFVA54ho0Ub4Ub2dZx+1SSjC1CH6elL8OsTBZY3WWfthAiEAxaiN1OCbsDk+FfF7no1t/VI0ehWdT78ShOLnsi9zrwU="}]},"_npmUser":{"name":"luigimannoni","email":"hello@luigimannoni.com"},"directories":{},"maintainers":[{"name":"luigimannoni","email":"hello@luigimannoni.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-documentation-generator_3.2.3_1618994011433_0.5284478631297946"},"_hasShrinkwrap":false},"3.2.4":{"name":"@deimosindustries/markdown-documentation-generator","version":"3.2.4","description":"Searches files for markdown and generates a static style/documentation guide. A fork of markdown-styleguide-generator.","main":"index.js","scripts":{"test":"node test.js"},"repository":{"type":"git","url":"git+https://github.com/deimosindustries/markdown-documentation-generator.git"},"keywords":["markdown","style guide","pattern library","css","sass","documentation"],"author":{"name":"Luigi Mannoni","email":"luigi@deimosindustries.com"},"license":"GPL-3.0","bugs":{"url":"https://github.com/deimosindustries/markdown-documentation-generator/issues"},"homepage":"https://github.com/deimosindustries/markdown-documentation-generator#readme","engines":{"node":">= 4"},"dependencies":{"chalk":"^2.4.2","cheerio":"^0.22.0","fs-extra":"^8.0.1","handlebars":"^4.1.2","highlight.js":"^10.4.1","lodash":"^4.17.11","marked":"^0.7.0","walk":"^2.3.9","yargs":"^13.2.4"},"devDependencies":{"nodemon":"^1.19.1"},"bin":{"md_documentation":"index.js"},"gitHead":"6f1f856c5acadcc60a9b63d80f489b1431703006","_id":"@deimosindustries/markdown-documentation-generator@3.2.4","_nodeVersion":"14.4.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-pRaoIFjkN3CP6TSG+0XL1TST+wjwbER9huN1eKqYg8+2v1JOdseP5WcWyTR843NBN9CWcxkp8illZ/PCdnJZUA==","shasum":"03637fb4868042a4754f4493d03973df56d2295b","tarball":"https://registry.npmjs.org/@deimosindustries/markdown-documentation-generator/-/markdown-documentation-generator-3.2.4.tgz","fileCount":22,"unpackedSize":428710,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgf+SxCRA9TVsSAnZWagAAzz0QAJ61Kvfv8Uk7M+VIbQew\nsdb1AjsqukKQfdxcBGAATPuJXNizWhKbUD89mu+yt/og6x9JdEBYFTsYtL49\niM8kBOc33brARn26Sf2gUWAVJVN8qNnrMMQXnOH6N6CosOVMaJ24C93ORejf\nnKfmf3uQ+tZs19IBf8tbf/1jrzASkUDfe/Z8UyGlukwOvzi0xTWx+LnPnm/Y\nIGWMredBWWgHMprbH9cOXRwrG1eqFQwhaMFtxYDduZPvtJKXoFZGtYsgiJBd\nWYCv3dzOMqOt8QWY+//bWUr7YczFzWi0VnVvARtQS8a96v5AO077AdE5aK2q\nXCm+qpufXu+T+H0HPG/3Jny2rX3w2M8SuZTUwv2R1z5SIEsu0rcf16cDXnvt\nBl0mXbPhAyQPbATgdXU7v7TbKNHAZC9IjmsgOma9EoZQqC47FqDdKYSzCa9I\n2e1dQIMi86OHp1rWl6na2iAkSDZpOr4zn7RJpLj7CjU3juBtpo4ssVqKcsov\nEsdsjPm+ImwbS6X99bbKHWKMPWhnWKPu7aK+jdIVwE/o1rF5DHReniaq6DKc\nCKzwtTvmdUbEaA5t6k+a0HuiMcpaDsHzeBeYsn0BAPwi7azvRblWj6cPVtvy\nJbPNL2D8UsQXxF7zP1AxLlh2GK50GiuKufvO7Bb4n/7Atoo9ByjZP0A3upOU\n9fJs\r\n=cjdU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFqTHUBK7MPRrbXBsc784bDB8Bx65ywXb9TXV0Y3w37OAiEAnRwS35/oR+Xge7IiJ4gavseGCwOCw0XJjisvhrS059M="}]},"_npmUser":{"name":"luigimannoni","email":"hello@luigimannoni.com"},"directories":{},"maintainers":[{"name":"luigimannoni","email":"hello@luigimannoni.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-documentation-generator_3.2.4_1618994353235_0.36612306969896413"},"_hasShrinkwrap":false},"3.2.5":{"name":"@deimosindustries/markdown-documentation-generator","version":"3.2.5","description":"Searches files for markdown and generates a static style/documentation guide. A fork of markdown-styleguide-generator.","main":"index.js","scripts":{"test":"node test.js"},"repository":{"type":"git","url":"git+https://github.com/deimosindustries/markdown-documentation-generator.git"},"keywords":["markdown","style guide","pattern library","css","sass","documentation"],"author":{"name":"Luigi Mannoni","email":"luigi@deimosindustries.com"},"license":"GPL-3.0","bugs":{"url":"https://github.com/deimosindustries/markdown-documentation-generator/issues"},"homepage":"https://github.com/deimosindustries/markdown-documentation-generator#readme","engines":{"node":">= 4"},"dependencies":{"chalk":"^2.4.2","cheerio":"^0.22.0","fs-extra":"^8.0.1","handlebars":"^4.7.7","highlight.js":"^11.1.0","lodash":"^4.17.21","marked":"^0.7.0","walk":"^2.3.9","y18n":"^5.0.8","yargs":"^13.2.4"},"devDependencies":{"nodemon":"^2.0.12"},"bin":{"md_documentation":"index.js"},"gitHead":"641a02735e77958bbabe42515f45f3ced5cfee16","_id":"@deimosindustries/markdown-documentation-generator@3.2.5","_nodeVersion":"14.4.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-Sd9pMzOhdGCqkXr7y+Khhlp2NvQ5MF26chE1Adu0CKQtrnCdDRL38QpIIUaeUTfsiL0KKimUj6NEoixyuRzrpA==","shasum":"d54d5ba37525b923fc4c8c63531aa9164ece75c1","tarball":"https://registry.npmjs.org/@deimosindustries/markdown-documentation-generator/-/markdown-documentation-generator-3.2.5.tgz","fileCount":22,"unpackedSize":428795,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAy2iCRA9TVsSAnZWagAAViQP/3DWU2Pz89VouCv4CDrN\nNm4vcUZFVBy1nlvLs0Ggmmc0En6fohUfCcdr3/armY+qVQePxXa5Pzg1kT2N\na7qRbuQQzVZFtEWBLWgiY3BC6lB7O3aFC97azrCJArP1081xIB0R6tKIB09S\nw3Cs9gwn8nOKyVTeN28wFmrCFDhu62aw9U4cWqNNKlzvJRqc+D5jFGpW/MDh\n79bFrqoFKTulyJ1e1jCRgWlR6DKqqMr5fNZ3hJqLMTgQ6/0BKGN4xP10kVrY\nE83hiz54J3CMYia8jChAR4N/pFLuQ78iyegXqolt+fxmdrk5iEpRcKxwAPcR\n7haqFpi5tXiTaV/k9eLQE2cXETmmHuplqYms47OQO+PtNjj+hIIkUdzcMx0J\nmMj34WKeYlfhhkY0o8IVAmd66AVAlx/pj94Vk6HTxhZvAoZjmhmjVR18fgic\nLI0+Yjamyrhh6l9hpWJIo+PjMS77iGzcHAxdrpQkjum0e+ddhE0ypyXaeIJ/\n1QKBn115NHIq7DsGG47Hb57vzNoaMOyLkMSW5B2PNv6G7kYqLCH7+F4s6epS\nhhjFJtGQk+0c+OA1tyWMYS3Vlr4n2sEFYeXeB7UF1GGjtBePaMu460NmaC5m\ntcEaouw/qJzOZZC2uZv0/oNeGhKNur/YBbw8qI/24KoLofaUaiGmexWEIbQA\nNnu8\r\n=M7WU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBgoxpW7IZzxYN7eH8P2Qss6pZ6g46hIiHqZdZ3lalgXAiEA90JQ7ikMuIYTKHREjvqkydirIjt3gJ/U7pUYfT1zC8w="}]},"_npmUser":{"name":"luigimannoni","email":"hello@luigimannoni.com"},"directories":{},"maintainers":[{"name":"luigimannoni","email":"hello@luigimannoni.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-documentation-generator_3.2.5_1627598241790_0.22791795753325372"},"_hasShrinkwrap":false}},"time":{"created":"2021-04-21T08:33:31.076Z","3.2.3":"2021-04-21T08:33:31.628Z","modified":"2022-04-05T03:39:36.274Z","3.2.4":"2021-04-21T08:39:13.471Z","3.2.5":"2021-07-29T22:37:22.040Z"},"maintainers":[{"name":"luigimannoni","email":"hello@luigimannoni.com"}],"description":"Searches files for markdown and generates a static style/documentation guide. A fork of markdown-styleguide-generator.","homepage":"https://github.com/deimosindustries/markdown-documentation-generator#readme","keywords":["markdown","style guide","pattern library","css","sass","documentation"],"repository":{"type":"git","url":"git+https://github.com/deimosindustries/markdown-documentation-generator.git"},"author":{"name":"Luigi Mannoni","email":"luigi@deimosindustries.com"},"bugs":{"url":"https://github.com/deimosindustries/markdown-documentation-generator/issues"},"license":"GPL-3.0","readme":"# markdown-documentation-generator\n### Screenshot\n![Screenshot](https://raw.githubusercontent.com/deimosindustries/markdown-documentation-generator/master/docs/screenshot-example.jpg)\n\n### What is a living style guide?\n> To me, a style guide is a living document of [style] code, which details all the various elements and coded modules of your site or application. Beyond its use in consolidating the front-end code, it also documents the visual language, such as header styles and color palettes, used to create the site. This way, it’s a one-stop place for the entire team—from product owners and producers to designers and developers—to reference when discussing site changes and iterations. [...] - [Susan Robertson/A list apart](http://alistapart.com/article/creating-style-guides)\n\nThe _living_ part means that it uses your **live** css. If you change your css files, the style guide will change as well!\n\n### What this tool does, short version:\nThis tool will search all your style files (your `.css`, `.scss` `_partial.scss`, `.less`, `.whatever`) for comments and create an html file living style guide for your developers to use. It also has some additional hooks for creating sass/less documentation.\n\n### What this tool does, longer version:\n\nBy parsing your comments with **markdown**, the generator will convert that data to **json**, which is then run through a (customizable) **handlebars** template to create a **static html** file.\n\nWhat you end up with is an html file that contains comments, rendered examples, and highlighted code, ready to be copied and distributed to your team.\n\nUltimately, the html file you end up with should inherit your site's css so your style guide is **always in sync with your codebase**. And since you are using markdown, your comment style is largely up to you and your team — they will be readable in and outside of your css.\n\nAll of this can be done via CLI or as part of a larger Node project, since the json, templates, and html are all publicly exposed. It's your data, so you can do with it whatever you please.\n\n## Install\n\nRequires [Node.js](http://nodejs.org/) (if you're unsure if you have node install, run `node -v` in a console.)\n\nInstall with npm:\n\n```\nnpm install @deimosindustries/markdown-documentation-generator\n```\n\n\n## Usage\n\n### CLI usage\n\nIf you want to use the default settings, run:\n```\ncd /your/web/project\nmd_documentation\n```\n\nYour html file will be created under /your/web/project/styleguide/styleguide.html\n\nTo override default configuration and create a `.styleguide` config file in the current working directory, you may run:\n```\nmd_documentation --init\n```\n\n### Node module usage\n\nUsing the default settings:\n```js\nvar styleguide = require('markdown-documentation-generator');\n\nstyleguide.create();\n```\n\nCustom options can be passed via an options object (or read from a `.styleguide` config file)\n```js\nvar styleguide = require('markdown-documentation-generator');\n\nvar options = {...};\n\nstyleguide.create(options);\n```\n\nSee the [configuration & customization](#configuration--customization\") section below for more information about customization.\n\n### Comment Style\n\nComment your css/scss/less/whatever files. Use Markdown in the comments:\n\nExample:\n\n\n    /* SG\n    # Glyphs/Style\n\n    You may resize and change the colors of the icons with the `glyph-`-classes. Available sizes and colors listed:\n\n    ```html_example\n    <p>\n      <i class=\"icon-search glyph-1x\"></i>\n      <i class=\"icon-search glyph-1_5x\"></i>\n      <i class=\"icon-search glyph-2x\"></i>\n      <i class=\"icon-search glyph-3x\"></i>\n    </p>\n    ```\n    */\n\n    a [class^=\"icon-\"],\n    a [class*=\" icon-\"] {\n      text-decoration: none;\n    }\n\n    [class^=\"icon-\"],\n    [class*=\" icon-\"] {\n      &.glyph-1x { font-size: 1em; }\n      &.glyph-1_5x { font-size: 1.5em; }\n      &.glyph-2x { font-size: 2em; }\n      &.glyph-3x { font-size: 3em; }\n    }\n\n    /* SG\n    ```html_example\n    <p>\n      <i class=\"icon-search glyph-red\"></i>\n    </p>\n    ```\n    **/\n\n    .glyph-red {\n      color: $moh-red;\n    }\n\n\n**This will be rendered as:**\n\n![Screenshot](https://raw.githubusercontent.com/deimosindustries/markdown-documentation-generator/master/docs/screenshot-rendered-glyphs.png)\n\n* `cd` to the web project (any folder containing css/scss/less files. The tool will search nested folders).\n* run `md_documentation` to generate style guide.\n* wait a few seconds and a `styleguide.html` is generated in `styleguide/` (this is configurable, see _Configuration_).\n\n### Syntax\nBest described by going through the example above line by line.\n\n##### Line 1 (Demarcation)\n\n```css\n  /* SG\n```\n\n`/*` is just an ordinary css comment. The `SG` means that this is a _style guide_ comment. Only comments beginning with `/* SG` will be included in the style guide, all other comments are ignored. This demarcation is configurable.\n\n\n##### Line 2 (Heading)\n\n```\n  # Glyphs/Style\n```\n\nEvery style guide comment must have a heading. `# ` is the Markdown syntax for a heading (equivalent to h1). The name of this category will be _Glyphs_ (which will be shown in the menu). The article will be  _Style_ (which will be shown in the menu when it's expanded). The heading (the part before the slash) is required, the slash and the article name are optional.\n\n\n##### Line 4 (Comment)\n\n```\n  You may resize and change the colors of the icons with the `glyph-`-classes. Available sizes and colors listed:\n```\n\nThe comment will be shown in the style guide. Describe your css rules! Feel free to use [Markdown syntax](https://help.github.com/articles/markdown-basics/). The comment is optional but be nice to your developers!\n\n\n##### Line 6-11 (Code example)\n\n    ```html_example\n    <p>\n      <i class=\"icon-search glyph-1x\"></i>\n      <i class=\"icon-search glyph-1_5x\"></i>\n      <i class=\"icon-search glyph-2x\"></i>\n      <i class=\"icon-search glyph-3x\"></i>\n    </p>\n    <p>\n      <i class=\"icon-search glyph-red\"></i>\n    </p>\n    ```\n\nThis is where you write some HTML code to describe how to use your css rules. The HTML will be a) Rendered and used as an example, and b) Output with syntax highlighting. The HTML part is optional but most of the time you'll use it. Notice that the code is fenced in triple back ticks (and given a language marker of `html_example`) as per Markdown syntax.\n\n\n##### Line 12 (Comment close)\n\n```\n  */\n```\n\nClosing the css comment.\n\n\n##### Line 13-24\n\n```\n  a [class^=\"icon-\"],\n  a [class*=\" icon-\"] {\n    text-decoration: none;\n  }\n  ...\n```\n\nOrdinary css! You could stop here and understand all you need to, but let's continue.\n\n##### Line 24+\n\n    /* SG\n    ```html_example\n    <p>\n      <i class=\"icon-search glyph-red\"></i>\n    </p>\n    ```\n    */\n\n    ...\n\nAdditional comments about the previous article. This allows you to break your comments up whenever and they will always become a part of the previous comment (and added to the same article).\n\n### Markdown files\n\nSometimes it makes more sense to have some of your documentation in a markdown file. In order to get around the limitations of using `/* */` inside markdown, it is necessary to instead use `<sg> </sg>` tags. Be sure to include `\"md\":true` in your `fileExtensions` setting if you intend on doing this.\n\n## Sections, Categories and Articles\n\nAll style guides are nested into three levels, with **sections** being the highest and **articles** being the lowest. Categories and articles are automatically generated based on the headings you create, but sections must be defined within your configuration.\n\nWith this in mind, it's worth thinking of sections as deep divisions in content (almost like their own pages). For instance, the two sections defined in the default configuration are \"styles\" and \"development\". A third possible section might be \"editorial\". For many, sections will be completely unnecessary.\n\n## Configuration & Customization\n\nIf you want to override the default configuration you may create a `.styleguide` file in your project folder (the same folder you run `md_documentation` in). Alternatively, you can pass custom options if you're invoking the module from within another Node application.\n\nThe easiest way to create a `.styleguide` file is to run `md_documentation --init` which will give you a boilerplate configuration file in the current working directory.\n\n### Options\n\n**sgComment** `'SG'`\n\nThe string you use to start your style guide comments. Can be anything, but it should be meaningful.\n\n\n**exampleIdentifier** `html_example`\n\nThe language attribute you use to identify code examples that will be rendered in your style guide.\n\n\n**sortCategories** `true`\n\nWhether to automatically sort categories and articles alphabetically.\n\n\n**sections** `{'styles':'', 'development':'Dev:'}`\n\nThe names of sections(keys) and their identifiers(values). The names will be output as-is, while the identifiers are searched for within the headings of articles and filtered out. For instance, using the settings listed above, a heading of `# Dev:Buttons/Small` would put this block into the \"development\" section(with the Article title being \"Small\", in the category of \"Buttons\").\n\nUsing `''` as an identifier will make this the \"default\" section -- meaning all articles without an identifier will be put into that section (in this case, the \"styles\" section).\n\n_Section identifiers cannot contain a \"/\" character_.\n\n\n**rootFolder** `'./'`\n\nDirectory to start looking for style guide commented files. All other paths will be relative to this (This path itself is relative to whatever directory the script is called from). Defaults to current working directory.\n\n\n**excludeDirs** `['target', 'node_modules', '.git']`\n\nDirectory names you want excluded from being scanned. Passed directly to [Walk](https://www.npmjs.com/package/walk) as a filter.\n\n\n**fileExtensions** `{scss:true, sass:true, less:true, md:true, css:false}`\n\nFile extensions to include in the scan for style guide comments.\n\n\n**templateFile** `'./node_modules/markdown-documentation-generator/template/template.hbs'`\n\nPath to a handlebars template to run your style guide data through.\n\n\n**themeFile** `'./node_modules/markdown-documentation-generator/template/theme.css'`\n\nPath to a CSS file to give your style guide some extra style. This is registered as a partial and can be referenced via `{{> theme}}`.\n\n\n**htmlOutput** `'./styleguide/styleguide.html'`\n\nPath to where you want to save your rendered style guide. Setting this to `true` will return the html as a String.\n\n\n**jsonOutput** `false`\n\nPath to where you want to save your style guide's json data. Setting this to any `true` will return the json as an Object.\n\n\n**handlebarsPartials** `{'jquery':'./node_modules/markdown-documentation-generator/template/jquery.js'}`\n\nPartial names(keys) and paths(values) to register to Handlebars before templating. jQuery is included as a default.\n\n\n**highlightStyle** `'arduino-light'`\n\nSyntax highlighting style. Syntax highlighting relies on highlight.js. See available [styles](https://highlightjs.org/static/demo/) and their [internal names](https://github.com/isagalaev/highlight.js/tree/master/src/styles).\n\n\n**highlightFolder** `'./node_modules/highlight.js/styles/'`\n\nFolder to look for highlight styles in. Default is highlight.js folder which is installed as a dependency to this package.\n\n\n**customVariables** `{'pageTitle': 'Style Guide'}`\n\nAdditional variables to make available to your templates (appended to your json). For instance, the default value can be accessed with `{{customVariables/pageTitle}}`.\n\n\n**markedOptions** `{'gfm': true}`\n\n[Marked](https://github.com/chjj/marked) options to be passed when rendering your comments. _Some options, like \"breaks\" and \"renderer\" will be overridden since they are essential to the way this application works._\n\n\n### Custom Themes\n\nThe final look and feel of the style guide is based on three different files:\n* [template file](https://github.com/deimosindustries/markdown-documentation-generator/blob/master/template/template.html) - Handlebars template which will produce the final html.\n* [theme file](https://github.com/deimosindustries/markdown-documentation-generator/blob/master/template/theme.css) - css file which will be included in the template file.\n* highlight file - Syntax highlighting relies on [highlight.js](https://highlightjs.org/). To change the highlight style - set the `highlightStyle` to the  name of the style (filename minus `.css`, [see the list of styles](https://github.com/isagalaev/highlight.js/tree/master/src/styles) ) in your `.styleguide`. See the [demos of available styles](https://highlightjs.org/static/demo/).\n\nTo create your own template/theme, copy the [template.html and theme.css](https://github.com/deimosindustries/markdown-documentation-generator/tree/master/template) to a folder of your choice. Then set the `templateFile` and `themeFile` in your `.styleguide` to the corresponding paths.\n\nThe Javascript object which you may use in your template file looks like this:\n\n```javascript\n{\n  \"sections\": {\n    \"section Name\": {\n      \"category\": \"Category Name\",\n      \"id\": \"category-name (HTML safe)\"\n      \"articles\": [\n        {\n          \"id\": 'Article ID (HTML safe unique identifier)',\n          \"category\": 'Parent Category (from the \"# Category/Heading\" Markdown)',\n          \"section\": {\n            \"name\": \"Parent Section\",\n            \"parentSection\": true //Useful for template checks (always camel-cased)\n          },\n          \"file\": \"File path where this article originated\",\n          \"heading\": 'Article Heading (from the \"# Category/Heading\" Markdown)',\n          \"code\": ['HTML Code', ...],\n          \"markup\": ['Highlighted HTML Code', ...],\n          \"comment\": 'Markdown comment converted to HTML',\n          \"priority\": 'Article sorting value' // Number\n        },\n        {...}\n      ],\n    },\n    ...\n  },\n  \"menus\": [\n    \"section Name\": [\n      {\n        \"category\": 'Category Name (one per unique \"# Category\")',\n        \"id\": 'Category ID (HTML-safe unique identifier)',\n        \"headings\": [\n          {\n            \"id\": 'Article ID (HTML-safe unique identifier)',\n            \"name\": 'Heading Name'\n          },\n          {...}\n        ]\n      },\n      {...}\n    ]\n  ],\n  \"customVariables\":{...}\n}\n```\n\nIf you'd like to see your own JSON, set a path in the `\"jsonOutput\"` option in your `.styleguide` file.\n\n\n## Run with gulp/grunt\n\nIf you want to re-create the style guide automatically every time a stylesheet file is changed, you can run it with your favorite task runner. One way of running it with gulp would be using gulp-shell to execute the shell command `md_documentation` when a file is changed.\n\nSample gulp script:\n\n```javascript\nvar gulp  = require('gulp');\nvar shell = require('gulp-shell');\nvar watch = require('gulp-watch');\n\ngulp.task('watch', function() {\n  gulp.watch('path/to/watch/for/changes/**/*.scss', ['makeStyleguide']);\n});\n\ngulp.task('makeStyleguide',\n  shell.task(\n    ['md_documentation']\n  )\n);\n\ngulp.task('default', ['watch']);\n```\n","readmeFilename":"README.md"}