How to use the command 'quarto' (with examples)
The ‘quarto’ command is an open-source scientific and technical publishing system built on Pandoc. It provides a set of command-line tools for creating, rendering, previewing, and publishing documents and websites.
Use case 1: Create a new project
Code:
quarto create-project path/to/destination_directory --type book|default|website
Motivation:
Creating a new project is the first step in using the ‘quarto’ command. This command allows you to specify the type of project you want to create, such as a book, a default project, or a website.
Explanation:
path/to/destination_directory: The path to the directory where you want to create the project.--type book|default|website: The type of project to create. Choose either “book” for a book project, “default” for a default project, or “website” for a website project.
Example output:
A new project is created in the specified destination directory with the specified type.
Use case 2: Create a new blog website
Code:
quarto create-project path/to/destination_directory --type website --template blog
Motivation:
Creating a new blog website is useful when you want to start a technical blog or share your work with others. This command creates a website project with a pre-defined blog template.
Explanation:
path/to/destination_directory: The path to the directory where you want to create the blog website.--type website: Specifies that you want to create a website project.--template blog: Specifies that you want to use the blog template for the website.
Example output:
A new blog website is created in the specified destination directory with the blog template.
Use case 3: Render input file(s) to different formats
Code:
quarto render path/to/file.{{qmd|rmd|ipynb}} --to {{html|pdf|docx}}
Motivation:
Rendering input files to different formats is useful when you want to convert your documents into various formats, such as HTML, PDF, or DOCX. This command allows you to specify the input file format and the output format.
Explanation:
path/to/file.{{qmd|rmd|ipynb}}: The path to the input file, which can be in Quarto Markdown (qmd), R Markdown (rmd), or Jupyter Notebook (ipynb) format.--to {{html|pdf|docx}}: Specifies the format to which you want to render the input file. Choose either “html” for HTML, “pdf” for PDF, or “docx” for DOCX.
Example output:
The input file is rendered to the specified output format.
Use case 4: Render and preview a document or a website
Code:
quarto preview {{path/to/destination_directory|path/to/file}}
Motivation:
Previewing a document or a website is helpful when you want to see how it looks before publishing or sharing it. This command allows you to preview either a document or a website.
Explanation:
path/to/destination_directory | path/to/file: The path to the destination directory or the file you want to preview. If you specify a destination directory, the command will preview the entire website.
Example output:
The document or website is displayed in a preview window where you can see how it looks.
Use case 5: Publish a document or project
Code:
quarto publish {{quarto-pub|gh-pages|connect|netlify}}
Motivation:
Publishing a document or project allows you to share it with others by making it accessible online. This command provides different options for publishing your work, such as using Quarto Pub, GitHub Pages, RStudio Connect, or Netlify.
Explanation:
quarto-pub: Publishes the document or project to Quarto Pub, an online platform for publishing and sharing scientific and technical content.gh-pages: Publishes the document or project to GitHub Pages, a tool that turns repositories into websites.connect: Publishes the document or project to RStudio Connect, a publishing platform for R Markdown documents.netlify: Publishes the document or project to Netlify, a platform for hosting and deploying websites.
Example output:
The document or project is published using the specified publishing option.
Conclusion:
The ‘quarto’ command provides a wide range of functionality for creating, rendering, previewing, and publishing scientific and technical documents and websites. With these use cases, you can leverage the power of ‘quarto’ to efficiently create and share your work.
