-
Notifications
You must be signed in to change notification settings - Fork 10
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 tomain
.
- Figures
- Image size
- TeX formulas
- Table caption
- Decorative headings
- Alerts (quote types)
- Quotation source
- Page breaks
- Text symbols (text replacement)
- Syntax of a function call
- Declaring functions
- Dynamic typing
- Including other Quarkdown files
- Importing external libraries
- Localization
- Document metadata
- Theme
- Page format
- Page margin content
- Page counter
- Automatic page break
- Numbering
- Table of contents
- Stacks (row, column, grid)
- Container
- Align
- Float
- Clip
- Box
- Collapsible
- Whitespace
- Variables
- Optionality
- Math
- Conditional statements
- Loops
- Let
- Destructuring
- String manipulation
- Table manipulation: sorting, computing, and more
- Generators
- String
- Number
- Markdown content
- Boolean
- None
- Enumeration entry
- Iterable
- Dictionary
- Range
- Lambda
- Size(s)
- Color
- Dynamic
- Paper: abstract, definitions, theorems, and more