Chirun produces flexible and accessible course notes, in a variety of formats, from LaTeX or Markdown source. It is aimed primarily at notes in the mathematical sciences.
This repository, chirun, is the source code of the Chirun Python package, providing the command line interface for building content.
The Chirun documentation, including information about the Chirun Public Content Builder and Chirun LTI Provider can be found at https://www.chirun.org.uk/docs.
A set of course notes are provided in either Markdown or LaTeX along with a configuration file config.yml. The chirun command then builds the requested outputs based on the contents of the configuration file.
- Markdown parsing is provided by Python Markdown.
- LaTeX parsing is provided by plasTeX.
Installation instructions for Linux and macOS can be found in the Chirun documentation.
Chirun can be used on Windows via WSL and following the Linux installation instructions.
Sample course, and its source code.
- Install the
chirunpackage using the instructions above - Clone the sample course:
git clone https://github.com/chirun-ncl/sample_course.git - Change into the directory you just cloned to and run
maketo build and view a local version of the sample course. - The finished website output will be in
./sample_course/build
There is a suite of unit tests in the unittests folder.
To run the tests, run make test, or python -m unittest unittests.