Giter Club home page Giter Club logo

docker-asciidoctor's Introduction

Asciidoctor Docker Container

:source-highlighter: coderay

The environment

This Docker container provides:

  • Asciidoctor 1.5.4
  • Aciidoctor Diagram with Graphviz integration so you can use plantuml and graphiz diagrams
  • Asciidoctor PDF (alpha)
  • Asciidoctor EPUB3 (alpha)
  • Source highlighting using CodeRay or Pygments
  • Asciidoctor backends
  • Asciidoctor-fopub
  • Asciidoctor-confluence
  • Lazybones (for Asciidoctor-revealjs)

How to use it

Just run:

docker run -it -v <your directory>:/documents/ asciidoctor/docker-asciidoctor

It will be directly mapped with [path]/documents of the container.

Once started, you just have to create AsciiDoc files (in the directory mentioned above) and run Asciidoctor commands like:

  • To run Asciidoctor on a basic AsciiDoc file:
asciidoctor sample.adoc
asciidoctor-pdf sample.adoc
asciidoctor-epub3 sample.adoc
  • To run AsciiDoc on an AsciiDoc file that contains diagrams:
asciidoctor -r asciidoctor-diagram sample-with-diagram.adoc
asciidoctor-pdf -r asciidoctor-diagram sample-with-diagram.adoc
asciidoctor-epub3 -r asciidoctor-diagram sample-with-diagram.adoc
  • To use Asciidoctor-backends use +-T+ with either /asciidoctor-backends or $BACKENDS followed by the backend you want to use. For example:
asciidoctor -T /asciidoctor-backends/slim/dzslides myFile.adoc
#or
asciidoctor -T $BACKENDS/slim/dzslides myFile.adoc
  • To use fopub, you first need to generate the docbook file then use fopub:
asciidoctor -b docbook sample.adoc
fopub sample.xml
  • To use asciidoctor-confluence
asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USER --password PASSWORD sample.adoc

docker-asciidoctor's People

Contributors

cexbrayat avatar ckyriakidou avatar fwilhe avatar gscheibel avatar hasalex avatar mojavelinux avatar roelvs avatar

Watchers

 avatar  avatar

Forkers

opuk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.