From fe79542dccad54ac08585778e7187b314e46bb27 Mon Sep 17 00:00:00 2001 From: Giorgio Garofalo Date: Sun, 6 Oct 2024 13:54:16 +0200 Subject: [PATCH] Update README.md: wiki --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4fb6a5e0..a1166794 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ Quarkdown banner
- CodeFactor + Status: development FMT: Ktlint - Status: development + CodeFactor

Download the latest build here  @@ -50,6 +50,8 @@ which offers layout builders, I/O, math, conditional statements and loops. This out-of-the-box scripting support opens doors to complex and dynamic content that would be otherwise impossible to achieve with vanilla Markdown. +Check the [wiki](https://github.com/iamgio/quarkdown/wiki) (WIP) to learn more about the language and its features. +   --- @@ -171,13 +173,13 @@ Java 17 or higher is required. Running the program with no command-line arguments runs it in REPL mode. This is great for familiarizing yourself with Quarkdown, but it's probably not what you're looking for. -Running `quarkdown path-to-file.qmd` will compile the given file, save the output to file and log its content. -If the project is composed by multiple source files, the target file must be the root one, i.e. the one that includes the other files. +Running `quarkdown file.qmd` will compile the given file, save the output to file and log its content. -> [!NOTE] -> The `qmd` extension is conventionally the standard one, but any can be used. +> If the project is composed by multiple source files, the target file must be the root one, i.e. the one that includes the other files. +> +> - [How to include other files?](https://github.com/iamgio/quarkdown/wiki/including-other-quarkdown-files) -**Options:** +### Options - **`-o `** or **`--output `**: sets the directory of the output files. If unset, defaults to `./output`.