github.com/chirun-ncl/chirun @v1.1.0
Chat with this repoWhat it actually does AI analysis from the code graph — generated when you open this
README
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.
Documentation
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.
How it works
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
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.
Demo
Sample course, and its source code.
Compile the Sample Course
- 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
Core symbols most depended-on inside this repo
Shape
Languages
Modules by API surface
For agents
$ claude mcp add chirun \
-- python -m otcore.mcp_server <graph>