Quarto extension "Custom Format" with template

[ratnanil]

TL;DR

I would like to create a quarto extension custom format, and provide the user with a starter template.qmd to start out. However, upon installation (quarto install gh-org/repo), the template.qmd is missing.

Description

The command quarto create extension format:typst zhaw-lsfm creates the following folder structure

.
├── _extensions
│   └── zhaw-lsfm
│       ├── _extension.yml
│       ├── typst-show.typ
│       └── typst-template.typ
├── README.md
└── template.qmd       # ← I'm interested in this file

If I distribute this extension via GitHub (https://github.com/ratnanil/quarto-text-extension) I can install the extension (quarto install extension ratnanil/quarto-text-extension ), which creates the following structure:

.
└── _extensions
    └── ratnanil
        └── zhaw-lsfm
            ├── _extension.yml
            ├── typst-show.typ
            └── typst-template.typ

As you can see, template.qmd is missing. How can template.qmd be copied next to _extensions?

[rgaiacs]

Hi @ratnanil,

users of your Quarto extension must install the extension and the template separate.

quarto install extension ratnanil/quarto-text-extension
quarto use template ratnanil/quarto-text-extension

[mcanouil]

You don't have to do the two.
quarto use will install the extension and copy the root files such as the "template.qmd" in your empty project.

If you want to use a template do quarto use, if you want the extension but not the template, do quarto add (quarto install extension is the old API).

See the documentation:

• https://quarto.org/docs/extensions/distributing.html
• https://quarto.org/docs/extensions/starter-templates.html#using-a-template

[ratnanil]

🤦🏼 thanks for your answer, that makes a lot of sense.