https://github.com/techmsi/autostyles
NPM module for transforming css into automatic style guides.
https://github.com/techmsi/autostyles
dev-tool javascript npm-module
Last synced: 11 months ago
JSON representation
NPM module for transforming css into automatic style guides.
- Host: GitHub
- URL: https://github.com/techmsi/autostyles
- Owner: techmsi
- License: mit
- Created: 2015-04-30T12:15:59.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-05-28T17:49:13.000Z (over 3 years ago)
- Last Synced: 2025-02-01T15:27:27.727Z (about 1 year ago)
- Topics: dev-tool, javascript, npm-module
- Language: JavaScript
- Size: 812 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# autostyles
NPM module for transforming css into automatic style guides.
[](https://github.com/Flet/semistandard)
## Install (Privately)
```bash
npm install --save-dev autostyles
```
### Run (Privately)
- add these lines to your package.json
```json
"scripts": {
"styleguide": "buildguide",
}
```
THEN
```bash
npm run styleguide
```
OR
## Install (Globally)
```bash
npm install autostyles -g
```
## Usage (Globally)
```bash
buildguide
```
You will be prompted for the source & destination folders. This information will be used to generate your style guide.
- ✔ Turn debug on to get log info? **yes**
- ✔ Source folder **./my-css** `Source folder containing css files`
- ✔ Destination folder **dist** `Destination folder final guide files`
# Examples
The css files located inside the `/css` folder
```
/css
|-- sample.css
|-- sample2.css
```
are transformed into
```
/dist
|-- index.html
|-- page0.html
|-- page1.html
|-- css
|-- autostyles.css
|-- autostyles.js
|-- sample.css
|-- sample2.css
```