use_qrtdown_article
< Back to Reference | View source
use_qrtdown_article()
Create a qrtdown article
Usage
use_qrtdown_article(name, title = name, pkg = ".")Arguments
| Argument | Description |
|---|---|
name |
The name for the article (without extension) |
title |
The title for the article |
pkg |
Path to the package root directory |
Value
Invisibly returns the path to the created article
Description
Creates a new article for the documentation website. Articles are website-only content stored in vignettes/articles/ - they are NOT registered as R vignettes and will NOT be built by R CMD check.
This is different from usethis::use_vignette() which creates actual R vignettes with engine metadata.
For the main “Get started” article, use use_qrtdown_getting_started() instead - it creates an article with its own navbar tab.