Skip to content
This repository has been archived by the owner on Nov 17, 2020. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@mpetrovich
mpetrovich committed Feb 25, 2020
1 parent 5c3327b commit 25cadb1
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ npm install stylemark

## Usage

### Command-line interface (CLI)
### On the command line

```sh
npx stylemark <config> [-w|--watch]
Expand All @@ -30,7 +30,7 @@ npx stylemark <config> [-w|--watch]
| `<config>` | JS or JSON file containing a configuration object |
| `-w`, `--watch` | Opens the generated styleguide in a browser and reloads when any matching input files are added or changed |

### Node.js API
### In Node.js

```js
const stylemark = require("stylemark")
Expand All @@ -40,12 +40,12 @@ stylemark(config)

## Configuration

| Property | Type | Default | Description |
| -------- | -------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------- |
| `input` | string or array of strings | | Input path globs. See [Globbing patterns](#globbing-patterns). |
| `output` | string | | Output directory path. Directories will be automatically created if they don't exist. |
| `cwd` | string | CLI: config file directory<br>Node.js: `process.cwd()` | Base path that `input` and `output` paths are relative to. |
| `name` | string | `Stylemark` | Display name of the generated styleguide. |
| Property | Type | Default | Description |
| -------- | -------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `input` | string or array of strings | | Input path globs. See [Globbing patterns](#globbing-patterns). |
| `output` | string | | Output directory path. Directories will be automatically created if they don't exist. |
| `cwd` | string | Config file directory | Base path that `input` and `output` paths are relative to. By default, paths are resolved relative to the config file when using the command line. |
| `name` | string | `Stylemark` | Display name of the generated styleguide. |

Example:

Expand Down

0 comments on commit 25cadb1

Please sign in to comment.