Skip to content

A small experimentation to check whether asciidoctor fit my need.

License

Notifications You must be signed in to change notification settings

PierreBtz/asciidoctor-experiment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

asciidoctor-experiment

A small experimentation to check whether asciidoctor fits my need or not.

Aim

Check what a developer without any knowledge of asciidoctor can hope to accomplish in two hours.

Structure

I made a sample file sample.adoc grouping all the features I would need to write my documentations. I also made a questions.adoc file with the questions I still have after those two hours.

Result

The results of the two previous files are available in the output directory. Of course, this output directory should be in the .gitignore in a standard project.

Usage

In case you wish to regenerate the documentation from sources, here is what you need:

  • ruby
  • the following ruby-gem: asciidoctor and pygments.rb (the gem I used for syntax highlighting).

Once you are setup, just run the following:

asciidoctor questions.adoc -o output/questions.html
asciidoctor sample.adoc -o output/sample.html

About

A small experimentation to check whether asciidoctor fit my need.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published