Skip to content

Latest commit

 

History

40 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Mathlingua Reference

A user-focused guide to writing mathematical knowledge in Mathlingua.

The reference is itself a Mathlingua collection: the pages live under content/ as .mlg prose files and are built, checked, and served with the mlg command from the sibling mathlingua tooling repository.

Layout

  • content/ — the pages, as .mlg files (Title:, SectionTitle:, SubsectionTitle:, and Text: prose blocks).
  • content/**/toc — per-directory tables of contents that set the sidebar order and titles.
  • mlg.json — collection configuration.
  • docs/ — the exported static site (generated; git-ignored).

Prose is Markdown with LaTeX. A fenced block tagged mlg is parsed, checked in the scope of its containing item, and rendered as Mathlingua. A block tagged mlg-fragment is syntax-highlighted but not checked, so it is appropriate for partial examples and may reference commands not defined in the reference.

Building

The Makefile drives everything through mlg. Point MATHLINGUA_DIR at your checkout of the tooling repo (default ../mathlingua).

make check   # check syntax and semantics of every page
make serve   # live viewer at http://localhost:3000
make build   # export the static site into ./docs
make clean   # remove ./docs

mlg.json sets formatOnCheck: false to preserve the reference's manually arranged prose during checks. The current formatter preserves fenced code and Markdown list structure, and treats {. ... .} and {{. ... .}} math fragments as indivisible units. Run mlg format explicitly when reflowing prose is wanted.

The current syntax references are the tooling repository's structural syntax and formulation syntax. syntax.txt is a historical design sketch, not the implemented grammar.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages