{"_id":"@asciidoctor-extender/adoc-ext-include-scss","_rev":"2-7c21f337d33626841470bb16f38bd148","name":"@asciidoctor-extender/adoc-ext-include-scss","dist-tags":{"latest":"0.1.0-BETA"},"versions":{"0.1.0-BETA":{"name":"@asciidoctor-extender/adoc-ext-include-scss","version":"0.1.0-BETA","description":"An asciidoctor.js extension for commented scss variable files inclusion. (plugin for asciidoctor.js-extender)","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["Asciidoc","asciidoctor.js","scss","extension","documentation"],"author":{"name":"Richard Rijnberk","email":"r.rijnberk@gmail.com"},"license":"MIT","dependencies":{"fs-extra":"^5.0.0"},"gitHead":"9c1cb2c19e1642637d72a71f1744c1c80f3db3c3","_id":"@asciidoctor-extender/adoc-ext-include-scss@0.1.0-BETA","_npmVersion":"5.6.0","_nodeVersion":"8.0.0","_npmUser":{"name":"rrijnberk","email":"r.rijnberk@gmail.com"},"dist":{"integrity":"sha512-ygGiVVVHcgM7z6dQQ4sKYKytPn/3gHBt55lRAUUR9YVMgHhmIp7wSf/tSm5FYaapRr+wea6R8aViliBR/lQ/TA==","shasum":"5859f10bdadb5d500185e1083b830ca88f9aaa7a","tarball":"https://registry.npmjs.org/@asciidoctor-extender/adoc-ext-include-scss/-/adoc-ext-include-scss-0.1.0-BETA.tgz","fileCount":8,"unpackedSize":8375,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBFzOGCaYsZ8+phgQo8s6mFyySdmTEatvqv9ZVAaSJltAiAsz6XG1Yd/uZF7VCc57Zm4YsKN7vdabxbxR/wDb3T6hA=="}]},"maintainers":[{"name":"rrijnberk","email":"r.rijnberk@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/adoc-ext-include-scss_0.1.0-BETA_1523302238737_0.7498327827337719"},"_hasShrinkwrap":false}},"time":{"created":"2018-04-09T19:30:38.656Z","0.1.0-BETA":"2018-04-09T19:30:38.802Z","modified":"2022-04-04T15:43:09.316Z"},"maintainers":[{"name":"rrijnberk","email":"r.rijnberk@gmail.com"}],"description":"An asciidoctor.js extension for commented scss variable files inclusion. (plugin for asciidoctor.js-extender)","keywords":["Asciidoc","asciidoctor.js","scss","extension","documentation"],"author":{"name":"Richard Rijnberk","email":"r.rijnberk@gmail.com"},"license":"MIT","readme":"# SCSS include plugin for asciidoctor-extender\nThis plugin allows for the inclusion of commented scss files in asciidoc. Mainly intended for use with variable files \nand in-file documentation.\n\n> **Important notice:**\n> This is a plugin for the \n> [asciidoctor.js-extender](https://www.npmjs.com/package/@asciidoctor-extender/asciidoctor.js-extender) project.\n\nIf you wish to [submit a bug](#registering-issues), [contribute](#contributing) or \n[request a feature](#requesting-new-features) please follow the guides at the end of this document.\n\n## Installation\nTo include the library in your project run the following command:\n```\nnpm install -S @asciidoctor-extender/adoc-ext-include-scss\n```\n\n## Configuration\nIn order to use the plugin with the asciidoctor.js-extender project add the plugin to the configuration:\n```javascript\n{\n  \"extensions\": {\n    \"include\": [\n      \"@asciidoctor-extender/adoc-ext-include-scss\",\n      ...\n    ]\n  },\n  ...\n}\n\n```\n\n## Usage\nTo create a description block use **H[ _1-7_ ]** followed by the header title and a description.\n```scss\n//@H2 Variables\n//@description This file contains the base variables for the application.\n```\n\nTo create a block of variables with descriptions use:\n```scss\n//@description The base color for all text\n$color-text: rgba(0, 0, 0, 1);\n\n//@description The color used for warning text\n$color-text--warning: rgba(255, 150, 60, 1);\n\n//@description The color used for error text\n$color-text--error: rgba(255, 0, 0, 1);\n```\nWhich renders as:\n\n| Name | Value | Description |\n|:--- |:----- |:----------- |\n| color-text | rgba(0, 0, 0, 1) | The base color for all text |\n| color-text—​warning | rgba(255, 150, 60, 1) | The color used for warning text |\n| color-text—​error | rgba(255, 0, 0, 1) | The color used for error text |\n\n\nSeperate with two empty lines to break up the block and start a new block:\n```scss\n//@description The base color for all text\n$color-text: rgba(0, 0, 0, 1);\n\n//@description The color used for warning text\n$color-text--warning: rgba(255, 150, 60, 1);\n\n\n//@description The color used for error text\n$color-text--error: rgba(255, 0, 0, 1);\n```\nWhich renders as:\n\n| Name | Value | Description |\n|:--- |:----- |:----------- |\n| color-text | rgba(0, 0, 0, 1) | The base color for all text |\n| color-text—​warning | rgba(255, 150, 60, 1) | The color used for warning text |\n\n| Name | Value | Description |\n|:--- |:----- |:----------- |\n| color-text—​error | rgba(255, 0, 0, 1) | The color used for error text |\n\n# Registering issues\nShould something be awry please feel free to register a bug by creating an issue labeled \"bug\" with a clear description \nof what fails, what is expected and steps to reproduce the error.\n\n# Contributing\nTo contribute to this library you can fork the library, implement the feature and create a pull request. Then create an \nissue labeled \"Contribution\" with a clear description of the feature and a reference to the pull request.\n\n# Requesting new features\nIn order to request a new feature please open a new issue labeled \"Feature request\" and a clear description of\nthe functionality that is requested.  ","readmeFilename":"README.md"}