GitHub - iamgio/quarkdown: 🪐 Markdown with superpowers — from ideas to presentations, articles and books. (original) (raw)

Table of contents

1. About
2. Demo
3. Targets
4. Comparison
5. Getting started
   1. Installation
   2. Creating a project
   3. Compiling
6. Mock document
7. Contributing
8. Sponsors
9. Concept

About

Quarkdown is a modern Markdown-based typesetting system, designed around the key concept of versatility, by seamlessly compiling a project into a print-ready book or an interactive presentation. All through an incredibly powerful Turing-complete extension of Markdown, ensuring your ideas flow automatically into paper.

Original credits: Attention Is All You Need

Born as an extension of CommonMark and GFM, the Quarkdown Flavor brings functions to Markdown, along with many other syntax extensions.

This is a function call:

.somefunction {arg1} {arg2}
   Body argument

Possibilities are unlimited thanks to an ever-expanding standard library, which offers layout builders, I/O, math, conditional statements and loops.

Not enough? You can still define your own functions and variables — all within Markdown. You can even create awesome libraries for everyone to use.

.function {greet}
   to from:
   **Hello, .to** from .from!

.greet {world} from:{iamgio}

Result: Hello, world from iamgio!

This out-of-the-box scripting support opens doors to complex and dynamic content that would be otherwise impossible to achieve with vanilla Markdown.

Combined with live preview and ⚡ fast compilation speed, Quarkdown simply gets the work done.

Check the wiki to learn more about the language and its features.

Check out the demo presentation here

Built with Quarkdown itself — source code

(Desktop view is suggested)

As simple as you expect...

Inspired by: X-ray flashes from a nearby supermassive black hole accelerate mysteriously

...as complex as you need.

Targets

• HTML
  • ✅ Plain output (default)
  • ✅ Slides via reveal.js
  • ✅ Paged (books, articles) via paged.js
    Paged documents require a webserver to render in the browser. See the -p option below.
• PDF
  • ✅ All document types and features supported by HTML are also supported when exporting to PDF.
  • Check the wiki's PDF export page to learn more.

The desired document type can be set by calling the .doctype function within the source itself:

• .doctype {slides}
• .doctype {paged}

Comparison

Getting started

Installation

Download quarkdown.zip from the latest stable release or build it with gradlew distZip, and unzip it.

• The bin directory contains the executable scripts. Optionally, adding it to your PATH allows you to access Quarkdown more easily.
• The lib/qmd directory contains .qmd libraries that can be imported into a project.

Java 17 or higher is required. All major operating systems are supported.

Creating a project

Running quarkdown create [directory] will launch the prompt-based project wizard, making it quicker than ever to set up a new Quarkdown project, with all metadata and initial content already present.

For more information about the project creator, check out its wiki page.

Alternatively, you may manually create a .qmd source file and start from there.

Compiling

Running quarkdown c file.qmd will compile the given file and save the output to file.

If the project is composed by multiple source files, the target file must be the root one, i.e. the one that includes the other files.

• How to include other files?

If you would like to familiarize yourself with Quarkdown instead, quarkdown repl lets you play with an interactive REPL mode.

Options

• -p or --preview: enables automatic content reloading after compiling.
  If a webserver is not running yet, it is started and the document is opened in the default browser.
  This is required in order to render paged documents in the browser.
• -w or --watch: recompiles the source everytime a file from the source directory is changed.

Tip

Combine -p -w to achieve live preview!

• --pdf: produces a PDF file. Learn more in the wiki's PDF export page.
• -o <dir> or --output <dir>: sets the directory of the output files. Defaults to ./output.
• -l <dir> or --libs <dir>: sets the directory where external libraries can be loaded from. Defaults to <install dir>/lib/qmd. (?)
• -r <renderer> or --render <renderer>: sets the target renderer. Defaults to html. Accepted values:
  • html
  • html-pdf (equivalent to -r html --pdf)
• --server-port <port>: optional customization of the local webserver's port. Defaults to 8089.
• --pretty: produces pretty output code. This is useful for debugging or to read the output code more easily, but it should be disabled in production as the results might be visually affected.
• --clean: deletes the content of the output directory before producing new files. Destructive operation.
• --strict: forces the program to exit if an error occurs. When not in strict mode, errors are shown as boxes in the document.
• --no-media-storage: turns the media storage system off. (?)
• -Dloglevel=<level> (JVM property): sets the log level. If set to warning or higher, the output content is not printed out.

Mock document

Mock, written in Quarkdown, is a comprehensive collection of visual elements offered by the language, making it ideal for exploring and understanding its key features — all while playing and experimenting hands-on with a concrete outcome in the form of pages or slides.

• The document's source files are available in the mock directory, and can be compiled via quarkdown c mock/main.qmd -p.
• The PDF artifacts generated for all possible theme combinations are available and can be viewed in the generated branch.

Contributing

Contributions are welcome! Please check CONTRIBUTING.md to know how contribute via issues or pull requests.

Sponsors

A special thanks to all the sponsors who supported this project!

Concept

The logo resembles the original Markdown icon, with focus on Quarkdown's completeness, richness of features and customization options, emphasized by the revolving arrow all around the sphere.

What could be mistaken for a planet is actually a quark or, more specifically, a down quark, an elementary particle that is a major constituent of matter: they give life to every complex structure we know of, while also being one of the lightest objects in existence.

This is, indeed, the concept Quarkdown is built upon.