/

For the complete documentation index, see llms.txt. This page is also available as Markdown.

CLI - Project creator

The project creator is a CLI project wizard that makes it fast to set up a new Quarkdown project.

quarkdown create [directory] launches the wizard and generates the project files in the given directory (it will be created if it does not exist). Not specifying a value for directory generates the files in the working directory.

The following information will be prompted via standard input, unless the corresponding option is set via command-line arguments:

DataAdditional infoCorresponding optionGenerated Quarkdown function
Project name--name.docname
AuthorsSeparated by commas--authors.docauthors
Document typepaged/slides/plain/docs--type.doctype
Document languageValid language tag or full name--lang.doclang
Color theme (unprompted)--color-theme.theme
Layout theme (unprompted)--layout-theme.theme

Additional options:

Create from template

A package can declare itself a project template, which you can use via the --template option.

quarkdown create --template @atoms/simple-cv:1.0.0

You can find templates on the Quarkdown Atoms catalog.

To make your own package a template, see Publishing packages.