# Quarkdown

> Quarkdown is a modern, open-source typesetting system that extends Markdown with powerful features inspired by LaTeX. It compiles Markdown-based documents into PDF, HTML, MD, TXT.

## Key Features

- **Familiar:** built on the well-known Markdown syntax, for a flat learning curve.
- **Elegant:** produces output that matches the quality of industry-leading tools.
- **Agent-friendly:** comes with a built-in skill for idiomatic fluency of your coding agents.
- **Customizable:** full control over document layout, aesthetics, and properties.
- **Secure by default:** a restrictive permission system limits access to system resources.
- **Versatile:** a single source compiles to multiple targets.
- **Reactive:** low-latency live previews for rapid iteration. The official wiki (100+ subdocuments) compiles in ~2 seconds.
- **Reusable:** repeated content can be turned into one-line function calls.
- **Easily deployable:** set a CD workflow up in under 3 minutes ([example](https://raw.githubusercontent.com/iamgio/iamgio.github.io/refs/heads/main/.github/workflows/build.yml)).

## Use Cases

- Research papers, theses, and academic articles
- Books and technical reports
- Slide presentations and lectures
- Documentation sites and wikis
- Knowledge bases and notes

## Learn More

For detailed documentation, syntax reference, scripting guides, and technical topics, visit the [Quarkdown Wiki](https://quarkdown.com/wiki/index.md).

In particular, check out the [Quickstart Guide](https://quarkdown.com/wiki/quickstart.md) for a hands-on introduction.

## Links

- [Website](https://quarkdown.com)
- [GitHub](https://github.com/iamgio/quarkdown)
- [Wiki](https://quarkdown.com/wiki/index.md)
- [API Docs](https://quarkdown.com/docs)
- [Blog](https://quarkdown.com/blog)
- [VS Code Extension](https://quarkdown.com/vs-code)