简体中文
English
Website review
This review may include AI-generated content and is not individually verified. Domain, certificate and other facts come from the observed data on this page.
What is Quarkdown?
Quarkdown is an open-source, Markdown-based typesetting system. You write in ordinary Markdown, then add Quarkdown's extensions to control layout, styling and document behavior. It compiles your source into finished documents, and the same tool covers several output types rather than requiring a separate program for each.
What it is used for
The site describes four document modes, each aimed at a different job:
| Mode | Typical use | What it replaces, per the site |
|---|---|---|
| Paged | Research papers, books, reports | LaTeX, Typst |
| Plain | Notes, knowledge bases, simple static sites | Notion, Obsidian |
| Docs | Wikis, technical documentation, large knowledge bases | GitBook, Docusaurus, MkDocs Material, VitePress |
| Slides | Lectures, talks, interactive presentations | Beamer, Google Slides |
The practical appeal is that a student writing class notes, a team maintaining a wiki and a researcher preparing a paper can all stay in Markdown instead of switching tools or learning a full typesetting language.
How it differs from plain Markdown
The page shows extensions that go beyond standard Markdown: document metadata such as an author and page margin, styled boxes (for example, a warning callout), and the ability to redefine how a Markdown element renders. In the site's example, a link extension is redefined so that occurrences of "Origami" are highlighted. Quarkdown also advertises agent-friendly features, meaning an AI assistant can be given built-in skills for writing Quarkdown.
Who it suits, and the trade-off
Quarkdown fits writers who already like Markdown but need layout control, consistent styling or presentation output. The trade-off is that its extensions are specific to Quarkdown, so documents using them are not portable to other Markdown tools without rework. If you only need basic notes, plain Markdown is simpler; if you need precise academic typesetting, LaTeX or Typst remain established alternatives.
A useful next step is to pick your most common document type, such as a report or a slide deck, and test whether Quarkdown's corresponding mode handles your formatting needs before committing a larger project to it.
How do I choose the right doctype in Quarkdown for a paper versus slides versus a wiki?
Choose by output medium first, not by content topic. In Quarkdown the doctype is a single declaration that switches the whole document model, so pick the one that matches how readers will consume the result:
.doctype { paged }for papers, reports and books. Use it when the deliverable needs page flow, margins and print-style layout — a research paper, a class handout, a formal report. It is the replacement for LaTeX/Typst-style workflows..doctype { slides }for lectures, talks and interactive presentations. Use it when the unit of reading is a slide rather than a page, and you want the deck to come from the same source as your notes. It stands in for Beamer or slide tools..doctype { docs }for wikis, technical documentation and large knowledge bases. Use it when navigation and many cross-referenced pages matter more than pagination. It targets the GitBook/Docusaurus/MkDocs/VitePress niche..doctype { plain }for notes, knowledge bases and simple static websites — lighter thandocs, closer to a Notion/Obsidian-style writing surface.
How to decide in practice
| If the reader… | Doctype | Typical artifact |
|---|---|---|
| prints or reads linearly, page by page | paged |
paper, report, book chapter |
| watches it projected or clicked through | slides |
lecture deck, conference talk |
| browses many linked pages | docs |
wiki, product docs |
| just reads a few flat notes or a small site | plain |
notes, simple static site |
A concrete scenario: you are writing a conference paper and also presenting it. Author the paper under paged, then produce the talk under slides — keeping shared prose (abstract, method description) in one place and letting each doctype handle layout, rather than forcing one document to serve both. For a team knowledge base that will later be published as a site, start with docs; drop to plain only if the structure stays small enough that documentation-style navigation would be overhead.
The practical test is the first thing a reader does with the output: turn a page, advance a slide, or click a link. That action names the doctype. Because Quarkdown lets you redefine Markdown elements from a single source, you can also carry custom styling across doctypes instead of rewriting it — see Quarkdown for the doctype and extension syntax before committing a large document to one mode.
Can Quarkdown replace LaTeX for writing research papers with figures, abstracts, and citations?
Quarkdown can cover the core of a research paper — figures, abstracts, and structured front matter — but "replace LaTeX" depends on how much of LaTeX's ecosystem you rely on. The page presents Quarkdown as a Markdown-based typesetting system with a paged document type explicitly positioned for "articles, books and reports," and it lists LaTeX among the tools it says it replaces. Its example paper shows the intended workflow: author and margin metadata in a header block, an image inserted with a width percentage and caption, an .abstract section, and blockquotes for quotations. That is a genuine paper skeleton written in Markdown rather than LaTeX markup.
What the evidence supports
- Figures: The sample uses
!( 70% )[ Black hole ]( img/blackhole.jpg )— a percentage width plus caption text in plain Markdown syntax. Simple placement is clearly first-class. - Abstracts: A dedicated
.abstractblock wraps the summary, so it is a structured element rather than a manual heading. - Front matter and layout:
.docauthorand.pagemargindirectives set author and page-margin details without boilerplate. - Paged output:
.doctype { paged }is the mode intended for articles and reports, which is the relevant choice for a paper rather than slides or docs. - Customization: Elements can be redefined from "a single source of truth" via extensions, which matters if a journal template demands specific styling.
What the page does not show
Citations are the weak point in the available evidence. The example includes a quotation attributed to a named researcher, but it does not demonstrate a bibliography, citation keys, or reference-list generation. Before committing, test your actual citation workflow: whether you can cite by key, switch between numeric and author–date styles, and produce a reference list that matches a target journal. If your field depends on BibTeX or a publisher's class file, treat that as the deciding test rather than the figure or abstract syntax, which the evidence already covers.
A practical decision path
- Draft one real paper section in Quarkdown using
.doctype { paged }, including two figures with captions and your abstract. - Add three citations and build the reference list in the style your venue requires.
- Compare the compiled PDF against your journal's formatting checklist — margins, headings, caption placement.
- Keep LaTeX in reserve if step 2 or 3 fails; the Markdown source remains readable either way.
For a course report, internal preprint, or a paper where you control the template, the Markdown-first workflow is a reasonable trade: less boilerplate, faster drafting, and a shallower learning curve than LaTeX. For submission to a venue with a mandatory LaTeX class and BibTeX pipeline, verify citation support first. If you want to compare approaches, the LaTeX project at LaTeX Project documents the standard toolchain, and Typst is another Markdown-adjacent typesetting option worth evaluating on the same citation test.
How does Quarkdown make AI agents able to write documents in its syntax?
Quarkdown approaches agent authoring through built-in skills: the page describes "Agent-friendly" support that lets an AI agent "speak fluent Quarkdown" without the user hand-holding it through the syntax. In practice, that means the agent is given a packaged description of Quarkdown's conventions—function calls like .doctype { paged }, .box type :{ warning }, .extend { link }, block attributes such as .abstract, and the shorthand for images and quotes—so its output follows the language's structure rather than plain Markdown with improvised HTML. The page also points to a published evaluation ("Read the eval"), which is the right place to check how reliably an agent actually produces valid documents.
A realistic scenario: you ask an agent for a short research-style brief. With the skill loaded, it can emit a paged document with an abstract, an image at a set width, and a styled callout box in one pass, instead of you converting a generic Markdown draft afterwards. Without it, expect the agent to fall back to ordinary Markdown and lose the typesetting features.
What to verify before relying on it
- Which agents are supported and how the skill is installed or attached to a session.
- Error behaviour: whether malformed function calls fail loudly or silently degrade to text.
- Scope of the skill: does it cover extensions and custom element redefinitions, or only core syntax?
- The eval results: task types tested and failure modes, not just a headline pass rate.
Decision criterion: if your workflow is "agent drafts, human finalises," skills mainly save cleanup time on structure; if it is "agent output ships directly," weight the eval and error-reporting behaviour far more heavily. For teams comparing document toolchains more broadly, Typst and LaTeX are the usual reference points for paged output.
How can I customize Markdown elements like links and paragraphs in Quarkdown?
You customize Markdown elements in Quarkdown by overriding them in one place with .extend, so every instance of that element—every link, every paragraph—picks up the new behavior without you editing each occurrence. The page's own example extends link with a .super style and extends paragraph so its content transforms any "Origami"/"origami" match into that styled text, then renders the paragraph with the change applied.
How the pattern works
- Target the element by name.
.extend { link }and.extend { paragraph }name the element you want to change; the customization applies wherever that element appears. - Attach styling or content rules. The link example adds a
.superstyle. The paragraph example usescontent :with amatch { ... }block to find a pattern and replace it with styled output. - Keep one source of truth. Because the rule lives in the extension rather than in each paragraph, changing the definition updates the whole document—useful for consistent link styling across a paper, or for a house style applied to every paragraph in a knowledge base.
A practical next step
Decide what should be uniform across your document before writing: link color or emphasis, paragraph-level formatting, or recurring terms that need special treatment. Put those in your .extend blocks near the top, then write normally. If you're producing both a paper and slides, check whether the same extension should apply under each .doctype—the page shows paged, plain, docs and slides as distinct output modes, so a styling rule that suits a report may need adjusting for slides.
For a concrete case: a team writing a technical wiki could extend link once to mark external references, and extend paragraph to flag deprecated API names, rather than hunting through pages by hand. Quarkdown's own documentation at Quarkdown covers the extension syntax in more depth.
How fast is Quarkdown's compilation and preview compared with other typesetting tools?
Quarkdown's page advertises "blazing fast compilation" and a "reactive preview" aimed at what it calls "typesetting for the impatient," but it publishes no benchmark numbers, so there is no stated figure to compare against other tools. The realistic answer is that speed depends on document size, output type (paged document, slides, docs site) and how much custom extension logic you use—treat the speed claim as a design goal to verify on your own files rather than a measured result.
What the page does and doesn't say
- Claimed: fast compilation plus a live, reactive preview that updates as you write.
- Not claimed: milliseconds-per-page figures, comparisons with LaTeX, Typst or site generators, or build times for large projects.
- Implied trade-off: Quarkdown compiles Markdown with extensions into different output "doctypes" (paged, plain, docs, slides), so heavier documents and custom element redefinitions will cost more time than a plain note.
How it compares in practice
| Tool | Typical speed feel | Where the time goes |
|---|---|---|
| Quarkdown | Advertised as fast with live preview; unmeasured publicly | Compiling extensions and the chosen doctype |
| LaTeX | Slow on large documents, multi-pass builds | Multiple passes for references, indexes, fonts |
| Typst | Generally quick incremental compiles | Incremental recompilation of changed content |
| Static site generators (Docusaurus, MkDocs, VitePress) | Fast for small sites, slower as pages grow | Rebuilding the whole site or large page trees |
This table reflects general behaviour of these tool families, not a head-to-head test of Quarkdown.
A concrete way to decide
If you write lecture slides or short reports, the reactive preview matters more than raw build time—you want the slide to refresh as you type. If you maintain a large wiki, test a full build of your real content before committing, because that is where compilation time usually becomes noticeable. A practical check: time a cold build and a one-word edit on your largest existing document, then compare with whatever you use today.
For a broader frame of reference, you can compare typical workflows in Typst or a documentation generator such as VitePress using your own sample files.
ovh.net
Fastly
User reviews (0)