Function reference
All functions and classes exported by qrtdown.
Functions
| Function | Description |
|---|---|
build_articles() |
Build Articles for Documentation Site |
build_citation() |
Build Citation Page |
build_home() |
Build Home Page |
build_llm() |
Build LLM-Optimized Documentation |
build_news() |
Build News/Changelog Page |
build_reference() |
Build Reference Documentation |
build_site() |
Build Package Documentation Site |
clean_site() |
Clean the built site |
deploy_site() |
Deploy site to Pages branch |
init_site() |
Initialize a qrtdown site |
preview_site() |
Preview the documentation site |
qrtdown_sitrep() |
Check qrtdown configuration |
rd_to_qmd() |
Convert Rd files to Quarto Markdown |
use_qrtdown() |
usethis Integration |
use_qrtdown_article() |
Create a qrtdown article |
use_qrtdown_citation() |
Add citation to package |
use_qrtdown_cli() |
Install qrtdown CLI |
use_qrtdown_codeberg_pages() |
Set up qrtdown with Codeberg Pages |
use_qrtdown_getting_started() |
Create a “Get started” article |
use_qrtdown_github_pages() |
Set up qrtdown with GitHub Pages |
use_qrtdown_version() |
Bump package version and update qrtdown config |