Skip to content

Ivan-Tamayo/asciidoctor-archetype

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

asciidoctor-archetype

A maven archetype to bootstrap an asciidoctor toolchain. No prerequisites other than Maven & Java required. (Caveat: until the asciidoctor maven plugin 1.5 is released, you will need to build it yourself. Look there: https://github.com/asciidoctor/asciidoctor-maven-plugin/ ) It also features an assembly that includes all files to recreate the documentation artifacts from the distribution package.

The required backends and the working dzslides fork for that are linked as submodules for easy updating from

Quick Start

  1. Clone this repository and update the submodules

    git clone https://github.com/wwerner/asciidoctor-archetype.git
    git submodule init
    git submodule update
  2. Build and install the archetype

    mvn install
  3. Go to the folder where you want to create your documentation project and say

    mvn archetype:generate -DarchetypeGroupId=net.wolfgangwerner.writing -DarchetypeArtifactId=asciidoctor-archetype
  4. Edit the sample document/slides in <your project>/src/doc

  5. Build the sample document/slides

    mvn install
  6. Pick up the results in <your project>/target/generated-docs

  7. Also take a look into the zip file. You should be able to extract it anywhere and run the build there.

About

A maven archetype to bootstrap an asciidoctor toolchain. No prerequisites other than Maven & Java required.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published