https://github.com/peopledoc/broccoli-styledown

Broccoli plugin for creating styledown html from css markup
https://github.com/peopledoc/broccoli-styledown

approved-public broccoli broccoli-plugin broccoli-styledown ghec-mig-migrated plugin styledown styleguide

Last synced: 17 days ago
JSON representation

Broccoli plugin for creating styledown html from css markup

• Host: GitHub
• URL: https://github.com/peopledoc/broccoli-styledown
• Owner: peopledoc
• License: mit
• Created: 2020-01-29T15:55:57.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-09-26T12:01:14.000Z (over 1 year ago)
• Last Synced: 2024-04-16T06:52:47.957Z (9 months ago)
• Topics: approved-public, broccoli, broccoli-plugin, broccoli-styledown, ghec-mig-migrated, plugin, styledown, styleguide
• Language: JavaScript
• Homepage:
• Size: 623 KB
• Stars: 0
• Watchers: 30
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# broccoli-styledown

Broccoli plugin for generating styleguide HTML with [@peopledoc/Styledown](https://github.com/peopledoc/styledown)

ℹ️ This package is forked from [kmiyashiro/broccoli-styledown](https://github.com/kmiyashiro/broccoli-styledown).

## Installation

Add the github registry in your `.npmrc` for @peopledoc scoped package:

```

# Points to Github NPM registry

@peopledoc:registry=https://npm.pkg.github.com

````

Then you can install it:

```bash

npm install --save-dev @peopledoc/broccoli-styledown

```

## Usage

```js

var compileStyledown = require('@peopledoc/broccoli-styledown');

var outputTree = compileStyledown([inputTrees], options)

```

* **`inputTree`**: An array of nodes, `['styles', 'styleguide']`. Only CSS-like files and your config MD file will be passed to Styledown.

* **`options`**: Hash of options

  * **`configMd`**: (Default: `config.md`) Styledown config markdown file. Path relative to any inputNode. *NOTE*: If there are multiple config files with the same name in different inputNodes, bad things will probably happen.

  * **`destFile`**: File to output generated styleguide HTML in build directory.

  * **`styledown`**: A hash of options for [`Styledown.parse`](https://github.com/styledown/styledown/blob/master/index.js)

## Development

### Tests

```bash

npm install

npm test

```

## Contributors

    

        

            

            


            KamiKillertO

        

    

    

        

            

            


            kmiyashiro

        

    

    

        

            

            


            ryuran

        

    

    

        

            

            


            GreatWizard

        

    

    

        

            

            


            MrChocolatine

        

    

    

        

            

            


            lifeart

        

    

## License

MIT