The following list contains supported Chirun packages that allow you to accomplish most common tasks in LaTeX.
\usepackage{booktabs} % For prettier tables.
\usepackage[colorlinks,linkcolor={blue}]{hyperref}
\usepackage[dvipsnames]{xcolor} % For applying a wide range of colours e.g. shaded boxes.
\usepackage{chirun} % Required for the \alttext command, embedding videos, etc.
\usepackage{amsfonts, amsmath, amssymb, amsthm} % Common packages used for equation formatting.
\usepackage{graphicx} % Required for inserting images.
\usepackage{listings} % For code highlighting.
\usepackage[most]{tcolorbox} % For coloured boxes.
\usepackage[authoryear]{natbib} % A supported package for citations.
\bibliographystyle{agsm} % agsm applies the Harvard referencing style.
\usepackage{pgfplots} % For plotting.
\pgfplotsset{width=10cm,compat=1.9}
\usepackage{tikz} % For flowcharts
\usepackage{xspace} % For spacing after macros.Creating a package using the Chirun Reference Guide
To create a basic working example in Chirun, create a TeX file in the editor of your choice and paste the following packages into your preamble, between your \documentclass{article} and \begin{document} commands. Then add your own LaTeX content between the \begin{document} and \end{document} commands.
For a working example built upon these packages, see the Chirun Reference Guide. This is a work in progress, but shows a range of LaTeX elements converted to HTML.
Downloadable source files in GitHub
We also have a downloadable template hosted in GitHub consisting of the following files:
- chirun-starter-template.tex – This is the main LaTeX document.
- references.bib – This contains some sample references so you can see how they’re structured.
- images/snail.jpg – This is a folder containing a sample image.
There is also a README.MD file, explaining how the package works. Please do not download this as part of the package. Chirun won’t know what to do with it.