https://github.com/thaispalmer/styleg

Simple style guide generator and visualizer
https://github.com/thaispalmer/styleg

cli generator styleguide

Last synced: about 1 month ago
JSON representation

Simple style guide generator and visualizer

• Host: GitHub
• URL: https://github.com/thaispalmer/styleg
• Owner: thaispalmer
• License: mit
• Created: 2018-08-03T19:12:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T16:01:59.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T17:26:26.060Z (3 months ago)
• Topics: cli, generator, styleguide
• Language: HTML
• Size: 90.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StyleG

## Description

**StyleG** is a command line tool to generate and visualize style guides for the web.

Useful for artists and developers who wants to create guides for consistent visual implementations, this tool generates a `.json` file that has all the parameters needed. And optionally it can build this data visually into a HTML file.

Currently, it has support for color palettes, font families and font icons. View [example folder](https://github.com/thaispalmer/styleg/tree/master/examples) for more information.

## Installation

Just run `npm i -g styleg` and it'll be installed globally.

## Usage

### `styleg [options] [command] [file]`

Shows style guide in browser for a given file (defaults to styleg.json)

### Options

#### `-V, --version`

Output the version number

#### `-p, --port `

Change listen port (default: 9800)

#### `--live-reload `

Change live reload port (default: 9801)

#### `-b, --build `

Build style guide into a HTML file

#### `-h, --help`

Output usage information

### Commands

#### `create [file]`

Create a new style guide file