An open API service indexing awesome lists of open source software.

https://github.com/asciidoctor/gulp-asciidoctor

gulp-asciidoctor
https://github.com/asciidoctor/gulp-asciidoctor

asciidoctor asciidoctor-extension gulp javascript

Last synced: 6 months ago
JSON representation

gulp-asciidoctor

Awesome Lists containing this project

README

          

# gulp-asciidoctor

[![Build](https://github.com/asciidoctor/gulp-asciidoctor/workflows/Build/badge.svg)](https://github.com/asciidoctor/gulp-asciidoctor/actions?query=workflow%3ABuild)
[![npm version](https://img.shields.io/npm/v/@asciidoctor/gulp-asciidoctor.svg)](https://www.npmjs.org/package/@asciidoctor/gulp-asciidoctor)

A [gulp](https://gulpjs.com) plugin to support Asciidoctor processing in gulp tasks.

## Installation

### Requirements

You need [Node](https://nodejs.org) installed on your machine to install and run the gulp-asciidoctor plugin.

You need [gulp](https://gulpjs.com) installed globally or in your project directory.

### Install gulp-asciidoctor via npm

```
$ npm install @asciidoctor/gulp-asciidoctor --save
```

### Install gulp-asciidoctor via yarn

```
$ yarn add @asciidoctor/gulp-asciidoctor
```

## Compatibility

The following table shows the compatibility of the gulp-asciidoctor releases with the
underlying Asciidoctor releases.

| gulp-asciidoctor release | Asciidoctor.js release |
| ------------------------ | ---------------------- |
| v1.0.6 | v1.5.2 or higher |
| v2.2.3 | v2.2.0 or higher |

## Documentation

More information can be found in the [documentation](./docs/modules/ROOT/pages/index.adoc) on Github.