Skip to content

CLI: Project creator

Giorgio Garofalo edited this page Mar 8, 2025 · 3 revisions

The project creator is a CLI project wizard that makes it blazingly 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 doesn't 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:

Data Additional info Corresponding option Generated Quarkdown function
Project name --name .docname
Authors Separated by commas --authors .docauthors
Document type paged/slides/plain --type .doctype
Document language Valid language tag or full name --lang .doclang
Color theme (unprompted) --color-theme .theme
Layout theme (unprompted) --layout-theme .theme

Additional options:

  • --empty: does not include sample initial content;
  • --main-file <name>: sets the name of the main .qmd source file. Defaults to main.
Clone this wiki locally