Noteworthy

         ,--.
       ,--.'|
   ,--,:  : |
,`--.'`|  ' :
|   :  :  | |
:   |   \ | :
|   : '  '; |
'   ' ;.    ;
|   | | \   |
'   : |  ; .'
|   | '`--'
'   : |
;   |.'
'---'

A powerful Typst framework for creating beautiful educational documents.

---

Quick Start

# Create project and get launcher
mkdir myproject && cd myproject
curl -O https://raw.githubusercontent.com/sihooleebd/noteworthy/master/noteworthy.py

# Launch
python3 noteworthy.py

Full Installation Guide

---

Features

Feature	Description
15+ Themes	Pre-built color schemes, easy customization
Modules	Math, plotting, geometry, data structures
Web Studio	Google Docs-style editing, Monaco editor, Yjs CRDT collaboration
Solo Mode	Single-user mode, previewing exclusively through tinymist
Fast Builds	Parallel compilation, incremental updates
PDF Output	Merged PDFs with bookmarks and metadata

---

Commands

Command	Description
python3 noteworthy.py	Launch Terminal UI
python3 noteworthy.py -g (-p) (-nc)	Launch Web GUI -p xxxx for specific port -nc for solo mode --bind 0.0.0.0 to accept non-local connections
python3 noteworthy.py -u (-n) (-f)	Update from GitHub -n for nightly -f for force
python3 noteworthy_cli.py	Non-interactive CLI build

Full CLI Reference

---

Documentation

Read the Docs

Section	Description
Getting Started	Installation and first project
Guides	Theming, modules, building
Reference	CLI, config files, API
Architecture	System internals

---

Example Project

• For the legacy branch(formerly master), see a complete example at math-noteworthy.
• For the master branch(formerly nightly-v1), see a complete example at calculus-1.
• Both projects are handmade by the project authors.

---

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

# Dev setup
git clone https://github.com/sihooleebd/noteworthy
cd noteworthy
uv sync
source .venv/bin/activate

---

License

MIT License — See LICENSE for details.

---

Acknowledgments

Built with:

• Typst — The typesetting system
• Tinymist — Fast live preview
• CeTZ — Drawing library
• FastAPI — Web framework
• Monaco Editor — Code editor

---

Created by Sihoo Lee & Hojun Lee

Noteworthy — A framework for noteworthy educational documents.