DEV Community

Miguel Cobá
Miguel Cobá

Posted on • Edited on • Originally published at blog.miguelcoba.com

AsciiDoc to HTML, PDF and ePub rendering examples

#asciidoc #beginners #ebook #writing

Ok, last time I mentioned the advantages of AsciiDoc compared to simple Markdown for writing complex works like books.

I also said that you can use the same AsciiDoc source file and process it to generate different formats like HTML, PDF and ePUB.

Today I am going to show you how some basic and advanced elements appear in each output format.

Let's see some examples.

Simple formatting 

Bold *text*. Don't f**org**et chars!

Italic _text_. Also wi__thi__n a word.

Monospace `text` too.
Enter fullscreen mode Exit fullscreen mode

Simple formatting rendering

Highlighting 

This text is #highlighted#
Enter fullscreen mode Exit fullscreen mode

Highlighting rendering

Subscript and superscript 

The water formula is H~2~O

Einstein's formula is E=mc^2^
Enter fullscreen mode Exit fullscreen mode

Subscript and superscript rendering

Lists 

We have unordered lists

* unordered
** and nested
** short
* list

ordered lists

. ordered
.. and nested
.. short
. list

and checklists

* [*] this is done
* [x] this too
* [ ] this is not even on the horizon
Enter fullscreen mode Exit fullscreen mode

Lists rendering

Description List 

Some Concept:: Some definition
Dog:: Your best friend
Enter fullscreen mode Exit fullscreen mode

Description List rendering

Footnotes 

Sometimes you need themfootnote:[They look very smart]
Enter fullscreen mode Exit fullscreen mode

Footnotes rendering

Keyboard, buttons, and menus 

kbd:[F11]

kbd:[Command+X]

Press the btn:[OK]

Select menu:View[Zoom > Reset]
Enter fullscreen mode Exit fullscreen mode

Keyboard, buttons, and menus rendering

Admonitions 

WARNING: Watch you step

TIP: Some info

NOTE: Remember the milk
Enter fullscreen mode Exit fullscreen mode

Admonitions rendering

Quotes and verses 

[quote, attribution, citation title and information]
Quote or excerpt text

[verse, Carl Sandburg, two lines from the poem Fog]
The fog comes
on little cat feet.
Enter fullscreen mode Exit fullscreen mode

Quotes and verses rendering

Equations and formulas 

stem:[sqrt(4) = 2]

stem:[[[a,b\],[c,d\]\]((n),(k))]
Enter fullscreen mode Exit fullscreen mode

Equations and formulas rendering

As you can see, it is worth investing in writing in AsciiDoc as this allows you generate a full range of popular formats like HTML, PDF, ePub, DocBook, among others. Here I showed you how it looks in PDF and ePub formats that are very popular in the eBook world.

One more thing, the output can be further customized by tweaking the style used to generate the output so you can even get a different ePub or PDF visual style from the same source by changing the default styles the AsciiDoc processor uses to generate its output.

I'll talk about that in a future post.

About

I'm Miguel Cobá. I write about Elixir, Elm, Software Development, and eBook writing.

Top comments (0)

Read next

velan profile image

Mastering Bruno: A Beginner's Guide to API Clients

Velan<> -

msnmongare profile image

How to Set Git Username and Password in Git Bash?

Sospeter Mong'are -

mitchell_cheng profile image

Text compression & Code splitting & Modern image formats - Performance optimization

Mitchell -

ipigantenk profile image

How to install SSH Server in Termux

Ipii -