Quarkdown Files

[!IMPORTANT] If you're using the VS Code extension, please update it to v1.0.4. The preview will fail to launch on previous versions.

Author's message
I, @iamgio, am currently relocating to a new country. I won't be able to dedicate much time to Quarkdown development for the next few weeks, so little patches will be most common.
Thank you for your understanding and support! Active development will resume as soon as I am fully settled.

Main features and changes

This small release comes with some quality-of-life improvements, especially for the CLI.

 

Pipe mode (--pipe)

The HTML output is no longer printed to stdout by default, and it's now replaced by a short message:

• For normal compilation: Success @ <output path>

• For live preview: Success in <elapsed time>

A new pipe mode has been introduced, which can be enabled with the --pipe option. In this mode, the HTML output is printed to stdout as before, files are not generated, and all other logs are suppressed.

This mode is useful for piping the output to other commands or files. For example:

:::bash
quarkdown c input.qd --pipe > output.html

 

Enhanced error reporting

Error boxes now show a snippet of the affected source code.

Runtime errors, such as unresolved files in .read, now show more detailed information.

 

Improved browser selection

The --browser (-b) option of quarkdown c and quarkdown start has been improved to support more flexible browser selection:

• Lookup by name is no longer fixed to a predefined set. You can now specify any browser whose path is present in the environment variable BROWSER_<NAME> (e.g. BROWSER_OPERA for -b opera).
  The previous predefined names are still supported.

• You can now also specify the full path to the browser executable (e.g. -b /usr/bin/firefox).

[!NOTE] Browser processes are launched as <path> <url>. It must be the user's responsibility to ensure the genuinity of the executable.

 

Unnumbered headings in table of contents

The .tableofcontents function now accepts an optional includeunnumbered boolean parameter.

When set to true, decorative headings (#! Heading) are also included in the generated table of contents.

Thanks @sanoakr!

What's Changed

• [dev] chore(deps): bump dependencies by @iamgio in https://github.com/iamgio/quarkdown/pull/235
• Add option to include unnumbered sections in table of contents by @sanoakr in https://github.com/iamgio/quarkdown/pull/232
• feat(cli): enhance browser selection by @iamgio in https://github.com/iamgio/quarkdown/pull/236
• [dev] refactor: make pipeline stages composable by @iamgio in https://github.com/iamgio/quarkdown/pull/238
• feat(cli): add --pipe option by @iamgio in https://github.com/iamgio/quarkdown/pull/239
• feat: enhance errors by @iamgio in https://github.com/iamgio/quarkdown/pull/240

Full Changelog: https://github.com/iamgio/quarkdown/compare/v1.11.0...v1.12.0

Sponsors

Shout out to our new sponsor: @vitto4 🎉