https://github.com/uroesch/asciidoctor-pdf-tutorial-theme

asciidoctor-pdf theme for technical tutorials
https://github.com/uroesch/asciidoctor-pdf-tutorial-theme

asciidoc asciidoctor asciidoctor-pdf asciidoctor-theme markup technical-documentation theme

Last synced: 11 months ago
JSON representation

asciidoctor-pdf theme for technical tutorials

• Host: GitHub
• URL: https://github.com/uroesch/asciidoctor-pdf-tutorial-theme
• Owner: uroesch
• Created: 2020-12-11T13:12:58.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-03T21:06:21.000Z (almost 3 years ago)
• Last Synced: 2024-10-31T22:33:02.574Z (over 1 year ago)
• Topics: asciidoc, asciidoctor, asciidoctor-pdf, asciidoctor-theme, markup, technical-documentation, theme
• Language: Ruby
• Homepage:
• Size: 2.26 MB
• Stars: 15
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

          
= asciidoctor-pdf-tutorial-theme

This is a custom theme for `asciidoctor-pdf` for producing technical 

documentation and tutorials with a modern look.

== Status

This repo is work in progress as not all layouts have been fully evaluated yet.

== Usage 

Clone the repo to some directory, preferably within your document project e.g. `tutorial`.

[source,shell]

----

git submodule add \

  https://github.com/uroesch/asciidoctor-pdf-tutorial-theme \

  tutorial

----

Run `asciidoctor-pdf` with the following additional options:

[source,shell]

----

asciidoctor-pdf \

  -a pdf-themesdir=tutorial \

  -a pdf-theme=tutorial.yml \

  -a pdf-fontsdir=tutorial/fonts \

  -a iconsdir=tutorial/icons \

  "book.adoc"

----

=== Sample PDFs

Sample PDFs generated from the `syntax.adoc`.

[cols="1,1",options="header"]

|===

| Doctype

| Link

| Book 

a| link:samples/book.pdf[Book sample PDF]

| Article

a| link:samples/article.pdf[Article sample PDF]

| Man page

a| link:samples/manpage.pdf[Man page sample PDF]

|===