https://github.com/rhiokim/flybook

:airplane: FlyBook is a simple utility to generate static website such as gh-pages, manual of you projects
https://github.com/rhiokim/flybook

cli documentation markdown react static-site static-site-generator

Last synced: 4 days ago
JSON representation

:airplane: FlyBook is a simple utility to generate static website such as gh-pages, manual of you projects

• Host: GitHub
• URL: https://github.com/rhiokim/flybook
• Owner: rhiokim
• Created: 2017-05-24T05:25:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-03T11:54:38.000Z (over 7 years ago)
• Last Synced: 2024-10-07T19:09:03.280Z (about 1 month ago)
• Topics: cli, documentation, markdown, react, static-site, static-site-generator
• Language: JavaScript
• Homepage: https://rhiokim.github.io/flybook
• Size: 656 KB
• Stars: 80
• Watchers: 8
• Forks: 8
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-list - flybook - pages, manual of you projects | rhiokim | 76 | (JavaScript)

README

        
[![](./docs/basic/images/logo-250x250.png)](https://rhiokim.github.io/flybook)

Just write markdown, Flybook will create your book.

`FlyBook` is a simple utility to generate static website. This is inspired by [funbook](https://funbook.js.org/) and [next.js export functionality](https://zeit.co/blog/next)

Rewrited using by **React** and **React DOM Server**

## Goals

Already we know that we can have a number of document tools to publish markdown docs.

So flybook will keep in simplest way to generate static web site for writing the manual of project

## How flybook works

![](./docs/media/flybook-flow-detail.png)

## Features

* Custom Styling (Google Fonts, Highlight.js)

* Theme (only support `light` and `dark` now)

* Responsive

## How to use flybook

For example, Flybook documentation structure look like below

```

$ ls /path/to/project/docs

  docs

  |____advanced

  | \____theme.md

  |____basic

  | \____getting-started.md

  | \____install.md

  |____examples

  | \____syntax-highlight.md

  |____readme.md

```

**globally**

```

$ npm i -g flybook

$ cd /path/to/project

$ flybook docs

> FlyBook was generated at /Users/rhio/Works/my/fly-book/out

```

**with NPM Project**

```

$ cd /path/to/project

$ npm install flybook --save-dev

$

$ vi package.json

  ,

  "scripts": {

    ...,

    "docs": "flybook docs --outdir=out"

  },

  ...

// after save

$ npm run docs

```

## Development

Turn on the auto build mode after `npm install`

```

$ git clone [email protected]:rhiokim/flybook

$ cd flybook

$ npm install

$ npm run build

```

After that you are able to see the notification with your code changes automatically

* npm run release   // build

* npm run docs      // generate a book with newest code

## License

MIT