Flybook screenshot

Flybook

Author Avatar Theme by Rhiokim
Updated: 1 Aug 2017
81 Stars

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

Categories

Overview:

Flybook is a simple utility that allows users to generate static websites. Inspired by funbook and next.js export functionality, Flybook was rewritten using React and React DOM Server. Its goal is to provide a simple way to generate static websites for writing project manuals.

Features:

  • Custom Styling: Flybook allows users to customize their static websites with options such as Google Fonts and Highlight.js.
  • Theme: Flybook currently supports light and dark themes.
  • Responsive: The generated static websites are responsive and can be viewed on different devices.

Installation:

To use Flybook, follow the steps below:

  1. Install Flybook globally with NPM by running the following command:
npm install -g flybook
  1. Ensure that you have a project set up with NPM.

  2. Turn on the auto build mode by running the command:

npm run release
  1. To generate a book with the latest code changes, run:
npm run docs

Summary:

Flybook is a utility that simplifies the process of generating static websites for writing project manuals. It offers features such as custom styling, support for light and dark themes, and responsiveness. To use Flybook, simply install it globally with NPM, set up an NPM project, and enable the auto build mode to see your code changes automatically reflected in the generated website.