Meta tags:
description=Learn how to get started with the basics of pkgdown. ;

Headings (most frequently used words):

page, introduction, to, pkgdown, metadata, accessibility, home, reference, articles, news, publishing, promoting, on, this, releases,

Text of the page (most frequently used words):
the (37), #pkgdown (31), you (27), and (25), your (18), site (17), for (11), version (11), can (10), reference (10), page (9), github (9), with (8), see (8), this (7), url (7), news (7), usethis (6), package (6), run (6), more (6), how (6), that (6), articles (6), functions (6), from (6), are (6), make (5), automatically (5), them (5), want (5), website (5), html (5), vignettes (5), index (5), contents (5), vignette (5), use_pkgdown_github_pages (4), description (4), lib (4), field (4), its (4), use (4), publish (4), actions (4), using (4), one (4), each (4), generated (4), all (4), get (4), _pkgdown (4), yml (4), also (4), spark (4), desc (4), title (4), topics (4), help (4), does (3), https (3), once (3), way (3), build (3), release (3), writing (3), will (3), level (3), headings (3), name (3), but (3), files (3), just (3), starts_with (3), defined (3), useful (3), linking (3), home (3), customise (3), work (3), learn (3), about (3), accessibility (3), auto (3), built (2), sure (2), include (2), org (2), source (2), should (2), easiest (2), builds (2), change (2), set (2), need (2), readme (2), including (2), rendered (2), into (2), changelog (2), markdown (2), provide (2), not (2), because (2), article (2), control (2), details (2), generate (2), started (2), while (2), other (2), topic (2), matches (2), reading (2), components (2), list (2), subtitle (2), optional (2), fields (2), default (2), human (2), described (2), override (2), includes (2), there (2), couple (2), possible (2), have (2), links (2), defaults (2), ensure (2), read (2), appearance (2), template (2), important (2), which (2), sites (2), quarto (2), metadata (2), build_site (2), everytime (2), update (2), rmd (2), introduction (2), developed, olivier, roy, posit, software, pbc, salim, brüggemann, maëlle, salmon, jay, hesselberth, hadley, wickham, social, media, rstats, repository, com, alongside, link, finalized, published, web, publicize, few, places, promoting, via, publishes, every, time, customize, action, publishing, add, announcements, navbar, drop, down, create, major, related, minor, versions, customisation, options, build_news, suggestions, bullets, tidyverse, style, guide, first, lots, bug, fixes, present, single, based, assumes, formatted, specify, number, two, topical, organization, large, use_article, due, has, integrate, own, relatively, little, available, over, output, format, build_articles, found, translating, recommended, intro, iterating, might, making, faster, quickly, affects, build_reference_index, note, select, common, prefix, complete, matching, helper, build_reference, ends_with, saveload, spark_write, spark_read, dataframes, data, spark_log, spark_install, spark_disconnect, spark_connect, spark_config, connections, installing, managing, connecting, entry, take, three, forms, generates, alphabetically, ordered, much, curation, grouped, categories, executes, examples, inserting, results, best, autolink, references, creates, function, translation, individual, generally, straightforward, things, bear, mind, man, tries, put, order, different, display, providing, both, homepage, sidebar, full, these, build_home, accessible, many, people, some, accessibilty, issues, only, solve, controlling, cerulean, bootswatch, bootstrap, another, option, allows, overall, used, throughout, absolute, urls, where, they, needed, part, what, enables, external, such, websites, yaml, file, called, most, gives, final, location, decent, without, any, additional, really, pops, rest, starts, showing, configure, main, then, promote, use_pkgdown, remove, docs, gitignore, checked, git, manually, regularly, goal, easy, elegant, minimum, basic, running, minutes, recommend, setting, dark, light, releases, translations, skip,

Text of the page (random words):
introduction to pkgdown pkgdown skip to contents pkgdown 2 2 1 get started reference articles customise your site quarto vignettes translations accessibility auto linking metadata more articles news releases version 2 2 0 version 2 1 0 version 2 0 0 version 1 6 0 version 1 5 0 version 1 4 0 version 1 3 0 version 1 1 0 version 1 0 0 changelog light dark auto introduction to pkgdown source vignettes pkgdown rmd pkgdown rmd the goal of pkgdown is to make it easy to make an elegant and useful package website with a minimum of work you can get a basic website up and running in just a couple of minutes if you re using github we recommend setting up pkgdown and github actions to automatically build and publish your site run this once to publish your site regularly usethis use_pkgdown_github_pages if you are not using github you will have to run pkgdown build_site manually everytime you want to update the site run once remove docs from gitignore to ensure it is checked into git usethis use_pkgdown run everytime you want to update your site pkgdown build_site while you ll get a decent website without any additional work if you want a website that really pops you ll need to read the rest of this vignette it starts by showing you how to configure pkgdown with a _pkgdown yml you ll learn about the main components of the site the home page reference articles and news and then how to publish and promote your site metadata you can override pkgdown s defaults with a yaml file called _pkgdown yml 1 the most important field is url which gives the final location of the site url https pkgdown r lib org url is used throughout the site to generate absolute urls where they are needed url is also part of what enables auto links to your help topics or vignettes from sites external to your package such as from other pkgdown sites or from quarto websites see vignette linking for more another important option is template which allows you to control the overall appearance of your site template bootstrap 5 bootswatch cerulean you can learn more about controlling the appearance of your site in vignette customise accessibility pkgdown s defaults work to ensure that your site is accessible to as many people as possible but there are some accessibilty issues that only a human can solve so make sure to also read vignette accessibility to learn about them home page the contents of the home page are automatically generated from index md or readme md pkgdown tries to put them in order so it s possible to have a different display on github and pkgdown by providing both files the homepage also includes a sidebar full of useful links see build_home for how these are generated and how you can customise them reference pkgdown creates a function reference in reference that includes one page for each rd help topic in man the translation of individual help topics from rd to html is generally straightforward but there are a couple of things you should bear in mind pkgdown does its best to autolink all references to help topics and articles described in vignette linking pkgdown executes all examples inserting the rendered results in the generated html files by default pkgdown generates a reference index that is just an alphabetically ordered list of functions the index is much more useful with human curation because functions can be grouped and described in categories to override the default provide a reference field in _pkgdown yml each entry in reference can take one of three forms a title defined by title and optional desc description fields a subtitle defined by subtitle and optional desc description fields a list of topics defined by a contents field reference title connecting to spark desc functions for installing spark components and managing connections to spark contents spark_config spark_connect spark_disconnect spark_install spark_log title reading and writing data desc functions for reading and writing spark dataframes contents starts_with spark_read starts_with spark_write matches saveload note the use of starts_with to select all functions with a common prefix you can also use ends_with and matches see complete details in build_reference including other topic matching helper functions while iterating on the reference index you might want to run pkgdown build_reference_index it just re builds the index page making it faster to quickly change _pkgdown yml and see how it affects your site articles pkgdown will automatically build all vignettes found in vignettes translating them to html files in articles it is recommended to name your intro article with your package name to generate a get started page automatically due to the way that pkgdown has to integrate r markdown generated html with its own html relatively little control is available over the output format you can see the details in build_articles if you want to include an article on the website but not in the package e g because it s large you can use usethis use_article to set it up news if news md is present it will be rendered into a single page changelog based on markdown level headings pkgdown assumes your news md is formatted using level one headings to specify package name and version number and level two headings to provide topical organization for each release pkgdown 1 1 0 bug fixes lots of them pkgdown 1 0 0 this is the first release of pkgdown see more suggestions for writing news bullets in the tidyverse style guide see build_news for more customisation options including how to create one page for each major version and related minor versions add release announcements to the news navbar drop down publishing if you use github the easiest way to build and publish your site is via github actions using github actions automatically builds and publishes the site every time you make a change the easiest way to set this up is to run usethis use_pkgdown_github_pages and if you need to customize the action see readme md r lib actions promoting once your finalized site is built and published on the web you should publicize its url in a few places the url field of your package description alongside a link to its source url https pkgdown r lib org https github com r lib pkgdown usethis use_pkgdown_github_pages does this for you your repository description on github usethis use_pkgdown_github_pages does this for you on social media make sure to include rstats on this page developed by hadley wickham jay hesselberth maëlle salmon olivier roy salim brüggemann posit software pbc site built with pkgdown 2 2 1