generator-readteractive

    0.0.0 • Public • Published

    Readteractive Generator

    CLI

    We provide a command line interface to easily generate your project doing scaffolding, so you do not need to remember the syntax of each file and you can just focus on writing.

    The Readteractive structure and files can be automatically generated using this CLI for your custom book.

    It also provides a tool for visualization of your book with current chapters and the links between them, so you can have a general overview of the narrative branches of your book.

    Installation

    First, install Yeoman and generator-readteractive using npm (we assume you have pre-installed node.js).

    npm install -g yo
    npm install -g generator-readteractive

    Then run the wizard and it will guide you:

    yo readteractive

    Features

    Book scaffolding

    Generate a new book.

    yo readteractive:book
    

    Chapter scaffolding

    Generate a new chapter or rename an existing chapter identifier (updating all links on all referenced chapters).

    yo readteractive:chapter
    

    Build your book

    Building your book is easier with a wizard.

    yo readteractive:build
    

    Graph visualization

    In development

    Shows a graph of your book with current chapters and the links between them.

    yo readteractive:graph
    

    That's all! Enjoy!

    Install

    npm i generator-readteractive

    DownloadsWeekly Downloads

    1

    Version

    0.0.0

    License

    MIT

    Unpacked Size

    3.92 MB

    Total Files

    14

    Last publish

    Collaborators

    • carleslc