Skip to content

uroesch/asciidoctor-resume-theme

Repository files navigation

asciidoctor html resume theme

This is a theme for formating a structured document such as a resume or CV (curriculum vitae). I used it to get a job and it obviously working as I still have one :).

Currently there are a few very simple color schemes available namely:

  • Red

  • Orange

  • Green

  • Purple

  • Dark Purple

  • Light Blue

How to write

There are two special rules for writing with this stylesheet. The first is to list personal information in a concise way the second is for the employment history.

Personal details, eduction and skills sections

A description list is used with the modified [horizontal] style to render as a table. The sytle modification is to space out the first column with a fixed width to align the output among the sections.

Sample

Asciidoctor code
== Personal Details
[horizontal]
Name:: Bilbo Baggins
Date of Birth:: December 25. 1996
Nationality:: New Zealand
Address:: Hobbit Avenue 9, Hobbiton
Email:: bilbo.baggins@middle.earth
Telephone:: +123 234 23 33
Mobile:: +123 432 32 33
personal details
Figure 1. Rendered result

Employment history section

The employment history section also uses description lists but requires role=expenrience to be defined to render correctly. An unnumbered list within the description list is rendered without bullets as the sample below shows.

Asciidoctor code
== Employment History

=== 01/2011~ -- Mines of Moria
[horizontal,role="experience"]
Title:: Mithril Quality Assurance
Responsibilities::
* Mail shirt quality assurance.
* Process optimization.
* Synergy seeker.
Technolgies::
* X-Ray Vision
* Hammer
employment history
Figure 2. Rendered result
ℹ️
This section is not yet complete, more samples to follow.

How to use

Copy the css file

Simply copy one of the css files e.g the orange one resume-orange.css to your projects root folder and run asciidoctor as follows:

asciidoctor -a stylesdir="$(pwd)" -a sytlesheet=resume-orange.css *.adoc

As a git submodule

Add the style as git submodule into your project.

git submodule add \
  https://github.com/uroesch/asciidoctor-resume-theme \
  resume

The run asciidoctor as shown below.

asciidoctor \
  -a stylesdir="$(pwd)/resume" \
  -a sytlesheet=resume-orange.css \
  *.adoc

Build from scratch

Prerequisites

  • ruby

  • rake

  • docker

Build

Simply type rake and the command will download a docker container for the build. And create the resume-*.css file.

rake

About

An asciidoctor html theme for writing your resume or CV

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published