/

Quarkdown

2.0.1

Docs

On this page

CLI - Compiler

quarkdown c <file> is the command for compiling a main source file into a browser-renderable output.

For all available options, refer to the CLI options page.

Permissions

Quarkdown uses a permission system to control what can be accessed during compilation. If a document attempts an action that requires a permission it does not have, a compilation error is raised.

By default, documents are granted a default set of permissions. You can grant or revoke permissions with the --allow and --deny options:

quarkdown c main.qd --allow network --allow global-read

The final permission set is computed as: defaults + allowed – denied.

Available permissions

NameDescription
project-readRead files within the project directory (default)
global-readRead files from the entire file system, including outside the project directory
networkAccess remote resources over the network (e.g. fetching remote media)
native-contentEmbed native content, such as raw HTML and CSS (default)
allShorthand for all of the above

project-read, global-read and network are only requested when the compiler needs access to a resource.

For example, when rendering to HTML:

  • The following requires project-read, because the media storage system is turned on for HTML output, and the compiler needs to handle the image file:
    ![Image](path/to/image.png)
  • The following doesn’t require network, because the compiler doesn’t access the resource, but rather lets the URL through, to be handled by the browser:
    ![Image](https://example.com/image.png)