Overview
Quarkdown is a revolutionary Markdown-based typesetting system that transforms your writing into a wide array of professional outputs, from print-ready books and academic papers to dynamic websites and comprehensive knowledge bases. It achieves this through a powerful, Turing-complete extension of Markdown, injecting scripting capabilities directly into your text.
Key Features
- Unleash Scripting Power: Define functions, variables, and logic directly within Markdown, enabling dynamic and complex content generation.
- Versatile Output Formats: Seamlessly compile your single project into plain HTML (for websites and knowledge management), paged HTML/PDF (for papers and books), interactive presentations (via reveal.js), and structured documentation.
- Intuitive Syntax: Built upon CommonMark and GFM, Quarkdown offers an approachable learning curve while introducing advanced features like functions, layout builders, I/O operations, math, and conditional logic.
- Rich Standard Library: Leverage an ever-expanding collection of pre-built components for sophisticated document creation.
- Effortless Workflow: Enjoy fast compilation speeds and a powerful VS Code extension for live previews, ensuring a smooth and productive writing experience.
- Cross-Platform Installation: Easy setup via install scripts or package managers like Homebrew and Scoop for Linux, macOS, and Windows.
Typical Use Cases
- Academic Papers & Books: Produce professional, print-ready documents with advanced typesetting capabilities.
- Websites & Blogs: Create static websites and continuously flowing content akin to Notion or Obsidian.
- Knowledge Bases & Wikis: Structure and present information effectively for documentation and learning platforms.
- Interactive Presentations: Design dynamic slideshows with built-in scripting for engaging delivery.
- Technical Documentation: Generate clear and navigable documentation for software and projects.
