Documentation
CalcMark is a calculation language that blends seamlessly with Markdown. Write your thinking in plain text, add calculations that reference each other, and watch results update as you type.
Where to Start #
| If you want to… | Go to… |
|---|---|
| Install and try CalcMark | Getting Started |
| Learn through a real-world scenario | Guides — system sizing, budgets, recipes, unit conversion |
| Look up a specific feature | User Guide — task-oriented sub-pages |
| Find the exact specification | Language Reference — formal spec with deep-linkable anchors |
| Copy a working document | Examples — complete worked problems |
| Try without installing | CalcMark Lark — browser playground |
| Contribute to CalcMark | Contributing — architecture, development setup, conventions |
Getting Started
Install CalcMark and run your first calculation.
User Guide
Complete guide to CalcMark features, editor shortcuts, and workflows.
The CalcMark Editor
A terminal-based editor with live results, Markdown preview, autocomplete, and keyboard-driven workflows.
IDE & Editor Setup
Use CalcMark in VS Code, Zed, Neovim, or Emacs with full language intelligence.
Language Reference
Formal specification for the CalcMark language.
CLI Reference
Complete reference for CalcMark CLI commands, flags, and shell completion.
Agents
Use CalcMark as a calculation engine from scripts, AI agents, and pipelines.
Go Package
Use go-calcmark as a library to evaluate CalcMark expressions and documents in your Go applications.
Custom HTML Templates
Theme CalcMark HTML output with CSS variables, or build a fully custom page using shared template partials.
Configuration
Customize CalcMark's locale, appearance, and formatter defaults.
Contributing
How to contribute to CalcMark — architecture, development setup, and conventions.
Examples
Tutorials, worked examples, and feature references for CalcMark.