# guide-book-generator

> A Simple Style Guide Book Generator

Latest version **1.1.0** (published 2021-02-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install guide-book-generator
pnpm add guide-book-generator
yarn add guide-book-generator
bun add guide-book-generator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-02-28 |
| First published | 2021-01-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Kelvin Biffi |
| Maintainers | kelvinbiffi |
| Keywords | style, guide, book, generator |

## Links

- npm: https://www.npmjs.com/package/guide-book-generator
- Repository: https://github.com/kelvinbiffi/Guide-Book
- Homepage: https://github.com/kelvinbiffi/Guide-Book#readme
- Issues: https://github.com/kelvinbiffi/Guide-Book/issues
- npm.io page: https://npm.io/package/guide-book-generator

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-02-28
- 1.0.1 — 2021-02-22
- 1.0.0 — 2021-01-30

## README

# Guide Book

The **Guide Book** Generator for Style Guides.

----------------------------

## How it works:

The **Guide Book** goal is to look for the predefined pattern, [showing here](#how-to-use), and use it to generate an HTML page showing the Categories, Elements, and Modules of your Style Guide.

----------------------------

## How to use

First of all on your **Source Files** (SCSS/SASS/STYLUS/LESS) use the below pattern:
```
/*GUIDE

<CATEGORY>|<SECTION>

<HTML>

*/
```

### Where
| PLACEBOLDER         | Description                            |
|---------------------|----------------------------------------|
| `<CATEGORY>`        | Category of the Example                |
| `<SECTION>`         | Sections of the example                |
| `<HTML>`            | Some HTML Elements                     |

----------------------------

## How to Setup

To setup the **Guide Book** create a JS file at main folder of your project, using as reference the below code:

```
const GuideBook = require('guide-book-generator');

const settings = {
  style: <BUILT_CSS_FILE>,
  source: <SOURCE_FOLDER>,
  output: <OUTPUT>,
}

const guideBook = new GuideBook();
guideBook.generate(settings);
```

### Where
| PLACEBOLDER         | Type            | Description                                                |   Example                 |
|---------------------|-----------------|------------------------------------------------------------|---------------------------|
| `<BUILT_CSS_FILE>`  | String          | The built style css file                                   | 'build/style.min.css'     |
| `<SOURCE_FOLDER>`   | String          | The Source Files (SCSS,STYLUS,LESS,...)                    | 'source/css'              |
| `<OUTPUT>`          | String          | The **folder** or **file** to generate the **Guide Book**  | 'guidebook/guide.html'    |

----------------------------

## Examples

To see examples access this Repository [Guide-Book-Example](https://github.com/kelvinbiffi/Guide-Book-Example)

----------------------------

## Requirements Version

- Node `v12.18.1`
- NPM  `6.14.5`

----------------------------

## Dependences

- [PrismJS](https://prismjs.com/)

---
_Source: https://npm.io/package/guide-book-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._