# giik

> A static site generator for book.

Latest version **0.0.4** (published 2014-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install giik
pnpm add giik
yarn add giik
bun add giik
```

Provides the command `giik`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2014-04-16 |
| First published | 2014-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Author | Po-Ying Chen |
| Maintainers | poying |
| Keywords | book, generator, markdown |

## Links

- npm: https://www.npmjs.com/package/giik
- Repository: https://github.com/poying/giik
- Issues: https://github.com/poying/giik/issues
- npm.io page: https://npm.io/package/giik

## Dependencies (14)

- [co](https://npm.io/package/co.md) ~3.0.5
- [ncp](https://npm.io/package/ncp.md) ~0.5.0
- [rrs](https://npm.io/package/rrs.md) ~0.0.4
- [nopt](https://npm.io/package/nopt.md) ~2.2.0
- [chalk](https://npm.io/package/chalk.md) ~0.4.0
- [debug](https://npm.io/package/debug.md) ~0.8.0
- [marked](https://npm.io/package/marked.md) ~0.3.2
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.3.5
- [rimraf](https://npm.io/package/rimraf.md) ~2.2.6
- [bluebird](https://npm.io/package/bluebird.md) ~1.2.1
- [thunkify](https://npm.io/package/thunkify.md) ~0.0.1
- [koa-compose](https://npm.io/package/koa-compose.md) ~2.2.0
- [pretty-hrtime](https://npm.io/package/pretty-hrtime.md) ~0.2.1
- [merge-descriptors](https://npm.io/package/merge-descriptors.md) 0.0.2

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.0.4 (latest) — 2014-04-16
- 0.0.3 — 2014-04-10
- 0.0.2 — 2014-04-06
- 0.0.1 — 2014-04-06
- 0.0.0 — 2014-04-06

## README

giik
----

A static site generator for book.

針對書籍的靜態網頁產生器

## 安裝

```bash
$ npm install -g giik
```

## 建立書籍

### 1. 建立新目錄

```bash
$ mkdir book
$ cd book
```

### 2. 建立 giik.js

可參考 [example-giik.js](./example-giik.js)

內建四個 middleware 可使用

1. markdown
2. jadeTemplate - 使用前必須安 jade
3. duration
4. copy

### 3. 建立放置書籍容（markdown）的目錄

```bash
$ mkdir source
```

在這個目錄下每一個子目錄都是一個 chapter，目錄名稱用來設定章節先後順序還有網址，像是現在我們建立第一章，然後期望他的網址長相是 `http://mydomain/chapter-one`

```
$ mkdir 1-chapter-one
```

在每個 chapter 下面必須有 `chapter.json` 這個檔案，裡面設定其他這個 chapter 的詳細資訊

```javascript
{
  "name": "什麼是 giik ？",
  "number": 1,
  "sections": [
    {
      "name": "GIIIIIIIIK!",
      "authors": ["Po-Ying Chen <poying.me@gmail.com>"],
      "number": null,
      "source": "./test.md"
    }
  ]
}
```

### 4. 產生網頁

```bash
$ giik source site
```

執行完後就能在 site 目錄下看到網們的網頁啦

## License

The MIT License (MIT)

[http://poying.mit-license.org/](http://poying.mit-license.org/)

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