Skip to content

Resources for learning documentation-as-code concepts using the AsciiDoc markup language.

Notifications You must be signed in to change notification settings

andreaslongo/learn-asciidoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Learning: AsciiDoc

Resources for learning documentation-as-code concepts using the AsciiDoc markup language.

General workflow

Write down content in a simple text file using your favorite editor.

file: notes.adoc
Notes

This is simple plain text content.

I have the following TODOs:

A
B
C

Add some AsciiDoc markup to your text.

file: notes.adoc
= Notes

This is simple *plain text* content.

I have the following TODOs:

* A
* B
* C

Preview your document in your web browser with the browser extension.

example browser extension

Render your document to a publishing format like HTML or PDF.

$ ./container/run.sh

$ asciidoctor notes.adoc
$ asciidoctor-pdf notes.adoc

$ ls
notes.adoc notes.html notes.pdf

Glossary

AsciiDoc

The markup language. You write your text files in the AsciiDoc format.

Asciidoctor

A tool for converting AsciiDoc to publishing formats like e.g. HTML and PDF.

About

Resources for learning documentation-as-code concepts using the AsciiDoc markup language.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages