gulp-asciidoctor-samples

This project shows how to use teh gulp-asciidoctor plugin to generate a documentations based on AsciiDoc files.

Build Status

Build Status

Prerequisites

  • NodeJS

    Download and install from https://nodejs.org/

  • Gulp

    Run: npm install gulp -g

  • Project dependencies

    Dependencies are installed automatically by npm. They are listed in the package.json.

    Run: npm install

How to run

To execute a build you have to run the command gulp in the root folder of the repository. If you like to experiment, you can run gulp dev. These command will run a gulp watcher, which rebuilds the documentation automatically for every change you made.

the Folders

  • /dist/

    The folder for ever generated output.

  • /docs/

    The folder is our documentation source.

  • /node_modules/

    Contains the installed dependencies.