From c00c0262f10fd40fbb4442b233d40c5a5fd788e2 Mon Sep 17 00:00:00 2001 From: Giorgio Garofalo Date: Thu, 22 Aug 2024 00:15:31 +0200 Subject: [PATCH] Update README.md: update comparison --- README.md | 95 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 59 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index eb24259c..9b3de775 100644 --- a/README.md +++ b/README.md @@ -64,38 +64,6 @@ Built with Quarkdown itself —   -## Installation - -Download `quarkdown.zip` from the [releases](https://github.com/iamgio/quarkdown/releases) page or build it yourself with `gradlew distZip`, and unzip it. -If you'd rather keep it minimal, `gradlew build` produces only the JAR file. - -The `bin` directory contains the executable scripts. Optionally, add it to your `PATH` to access Quarkdown more easily. - -Java 17 or higher is required. - -## Getting started - -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. - -> [!NOTE] -> The `qmd` extension is conventionally the standard one, but any can be used. - -**Options:** - -- **`-o `** or **`--output `**: sets the directory of the output files. If unset, defaults to `./output`. - -- **`--pretty`**: produces pretty output code. This is useful for debugging or to read the output code more easily, - but it should be disabled in production as the results might be visually affected. - -- **`--clean`**: deletes the content of the output directory before producing new files. Destructive operation. - -- **`--strict`**: forces the program to exit if an error occurs. When not in strict mode, errors are shown as boxes in the document. - -- **`-Dloglevel=`** (JVM property): sets the log level. If set to `warning` or higher, the output content is not printed out. - ## Comparison | | Markdown | LaTeX | Quarkdown | @@ -116,21 +84,41 @@ If the project is composed by multiple source files, the target file must be the ```latex +\tableofcontents + \section{Section} + \subsection{Subsection} + \begin{enumerate} \item \textbf{First} item \item \textbf{Second} item \end{itemize} + \begin{center} This text is \textit{centered}. \end{center} + +\begin{figure}[!h] + \centering + \begin{subfigure}[b] + \includegraphics[width=0.3\linewidth]{img1.png} + \end{subfigure} + \begin{subfigure}[b] + \includegraphics[width=0.3\linewidth]{img2.png} + \end{subfigure} + \begin{subfigure}[b] + \includegraphics[width=0.3\linewidth]{img3.png} + \end{subfigure} +\end{figure} ``` ```markdown +.tableofcontents + # Section ## Subsection @@ -140,6 +128,13 @@ If the project is composed by multiple source files, the target file must be the .center This text is _centered_. + +.row alignment:{spacebetween} + ![Image 1](img1.png) + + ![Image 2](img2.png) + + ![Image 3](img3.png) ``` @@ -147,6 +142,38 @@ If the project is composed by multiple source files, the target file must be the +## Installation + +Download `quarkdown.zip` from the [releases](https://github.com/iamgio/quarkdown/releases) page or build it yourself with `gradlew distZip`, and unzip it. +If you'd rather keep it minimal, `gradlew build` produces only the JAR file. + +The `bin` directory contains the executable scripts. Optionally, add it to your `PATH` to access Quarkdown more easily. + +Java 17 or higher is required. + +## Getting started + +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. + +> [!NOTE] +> The `qmd` extension is conventionally the standard one, but any can be used. + +**Options:** + +- **`-o `** or **`--output `**: sets the directory of the output files. If unset, defaults to `./output`. + +- **`--pretty`**: produces pretty output code. This is useful for debugging or to read the output code more easily, + but it should be disabled in production as the results might be visually affected. + +- **`--clean`**: deletes the content of the output directory before producing new files. Destructive operation. + +- **`--strict`**: forces the program to exit if an error occurs. When not in strict mode, errors are shown as boxes in the document. + +- **`-Dloglevel=`** (JVM property): sets the log level. If set to `warning` or higher, the output content is not printed out. + ## Targets HTML is currently the only supported rendering target. LaTeX rendering is a future goal. @@ -160,10 +187,6 @@ The desired document type can be set by calling the `.doctype` function within t - `.doctype {slides}` - `.doctype {paged}` -> [!TIP] -> If not set via the command line argument `--out ` or `-o `, -> output files are saved into the `output` directory by default. - ## Scripting