use_qrtdown_getting_started

< Back to Reference | View source

use_qrtdown_getting_started()

Create a “Get started” article

Usage

use_qrtdown_getting_started(pkg = ".", title = NULL)

Arguments

Argument	Description
pkg	Path to the package root directory
title	The title for the article. Defaults to “Getting started with {package”

Value

Invisibly returns the path to the created article

Description

Creates the main “Get started” article for your package. This article gets its own tab in the navbar (separate from the Articles dropdown), following the pkgdown convention.

The article is saved as vignettes/articles/{packagename.qmd, which qrtdown automatically recognizes as the “Get started” article.

Examples

## Not run: 
# Create the Get started article
use_qrtdown_getting_started()

## End(Not run)