Documentation

This is the full reference for JamsEDU. If you have not already, start with Getting Started and Configuration from the main navigation before diving into the topics below.

A full jamsedu --build emits sitemap.json for the built-in masthead search. Put websiteUrl in .jamsedu/config.js when you also want sitemap.xml emitted under destDir. --watch rebuilds pages incrementally and does not rewrite those index files on every save, so run --build before deploy or when you need indexes to match the whole tree. Visit the Configuration page for more details.

Authoring and Building

JHP Templates: Write pages using standard HTML with JHP directives for includes, variables, conditionals, and output buffering.
Build Hooks: Run your own JavaScript during the build to modify HTML structure, inject markup, or normalize content across pages.
Quarto Live Demos: If you are used to authoring in Quarto (.qmd), JamsEDU makes it easy to use your existing skills and workflow.

Built-In Feature Guides

The Built-In Features page has live examples of everything listed here. These individual guides go deeper into markup, options, and customization.

KaTeX Math: Render LaTeX math formulas inline or as standalone blocks.
Mermaid Diagrams: Create flowcharts, sequence diagrams, and more from plain text.
Code Highlighting: Syntax highlighted code blocks with line numbers and a copy button.
Rich Text: Turn any textarea into a lightweight editor with formatting controls.
Embedded PDF: Display PDF documents directly on the page for viewing.
Tiny Doc: Structured documents with sections, fields, repeatable rows, print or save support, and a compact field reference on the same page.
Quarto with JamsEDU: Crash course for using .qmd files in JamsEDU, including Quarto shortcode usage and built-in feature patterns.

Customization

Runtime options (jamsEduConfig): Turn loaders off, pin CDN versions, or tune per-feature behavior in assets/js/main.js. This is separate from CLI Configuration.
CSS and Theming: Design tokens, color modes, and how to make every built-in feature match your brand.