---
title: "use_qrtdown"
---

[< Back to Reference](../reference.qmd) | [View source](https://usrbinr.codeberg.page/qrtdown//src/branch/main/R/usethis.R#L24)

# `use_qrtdown()`

usethis Integration

## Usage

```r
use_qrtdown(pkg = ".", config_file = NULL)
```

## Arguments

| Argument | Description |
|----------|-------------|
| `pkg` | Path to the package root directory |
| `config_file` | Path to a configuration file to use as template |

## Value

Invisibly returns the path to the created _qrtdown.yml

## Description

Functions that integrate with usethis for easy setup and maintenance
of qrtdown documentation sites.
Set up qrtdown for a package

Initializes qrtdown in an R package, creating necessary configuration
files and setting up the documentation structure. This is analogous to
`usethis::use_pkgdown()`.

## Examples

```r
## Not run: 
# Set up qrtdown in current package
use_qrtdown()

## End(Not run)
```

