Live Preview: Open a live preview of your .qmd file side by side with the editor. Any changes you make in the editor will be reflected instantly in the preview.
Create New Project: Easily create a new Quarkdown project.
Compile to HTML: Compile your Quarkdown document to an HTML file.
Compile to PDF: Compile your Quarkdown document to a PDF file.
Commands
You can access these commands from the VS Code Command Palette (Ctrl+Shift+P or Cmd+Shift+P):
Quarkdown: Open Preview to the Side: Opens a preview panel for the current .qmd file.
Quarkdown: Create New Project: Initiates the process to create a new Quarkdown project.
Quarkdown: Compile Document to HTML: Compiles the active .qmd document to an HTML file.
Quarkdown: Compile Document to PDF: Compiles the active .qmd document to a PDF file.
Configuration
You can configure the following settings in VS Code's settings (File > Preferences > Settings):
quarkdownPreview.quarkdownPath: Specifies the path to the Quarkdown executable. If Quarkdown is in your system's PATH, you can simply use quarkdown. Default is quarkdown.
quarkdownPreview.outputDirectory: Sets the compilation output directory. An empty value means using the system's temporary directory. Default is empty.
Usage
Open a .qmd file: Open any file with the .qmd extension in VS Code.
Open Preview: Use the command Quarkdown: Open Preview to the Side from the Command Palette, or click the "Open Preview" icon in the editor's title bar when a .qmd file is open.
Compile: Use the "Compile Document to HTML" or "Compile Document to PDF" commands to generate output files.