(ky-run)

Note

The Chirun project is under active development and so the contents of this documentation are subject to change.

As of May 2023, the Chirun LTI tool and web builder/editor are being completely rewritten. This version of the documentation is up to date with that, but is missing a lot of detail while the features settle down.

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.

Multiple outputs are supported automatically. So, for example, the same source document can produce an HTML web page that can be easily viewed on desktop, mobile or tablet; slides that can be used to give a presentation or lecture; a PDF ready for printing; or a Jupyer notebook.

Chirun can be used to convert either a single input file at a time, or a collection of files combined as a package. It generates static output which can be uploaded to a web server or learning management system for distribution to learners.

There are two parts to Chirun: the processing tool, and a web frontend.

The web frontend is the usual point of entry for most authors.

Users with more particular requirements can use the command-line processing tool on its own.

Introduction

• Sample Course Demonstration
• Licensing and OSS Stack

Information for Authors

• Tutorial
• Reference
  • The structure of a Chirun package
  • Package-level settings
  • Content Item Types
  • Chirun Markdown Extensions
  • Chirun LaTeX Package
• The Chirun web frontend
  • Unauthenticated use on the web
  • Managing packages
  • The build process
• Chirun Python Package
  • Installation Instructions
  • Convert a Standalone Document
  • Compile a Chirun Course Package
  • Command Line Arguments