_pkgdown.yml

destination: reference

# website will be referenced on https://pkgs.rstudio.com/
# Open a PR in https://github.com/rstudio/pkgs.rstudio.com
url: https://pkgs.rstudio.com/rticles/

template:
  package: tidytemplate
  bootstrap: 5
  bslib:
    primary: "#096B72"
    navbar-background: "#e6f3fc"
  trailing_slash_redirect: true
  opengraph:
    image:
      src: man/figures/logo.png
      alt: "rticles package"
    twitter:
      creator: "@rstudio"
      card: summary

development:
  version_tooltip: "Development version"

home:
  links:
  - text: Learn more about R Markdown
    href: "https://rmarkdown.rstudio.com"

# custom footer for rmarkdown ecosystem
footer:
  structure:
    left: [rmd]
    right: [developed_by, p, built_with]
  components:
      p: "\n\n"
      rmd: |
        **rticles** is a part of the **R Markdown** ecosystem of packages for creating
        computational documents in R.<br>Learn more at
        [rmarkdown.rstudio.com](https://rmarkdown.rstudio.com/).

# structure of website themed for R Markdown ecosystem
navbar:
  structure:
    left:  [intro, examples, articles, reference, news]
  components:
    examples:
      text: Examples
      href: articles/examples.html

# Add articles menu using
# https://pkgdown.r-lib.org/dev/reference/build_articles.html#index-and-navbar
# aticles:

news:
  releases:
  - text: "No blog post"
  # - text: Version 0.2
  #   href: <url>

authors:
  footer:
    roles: [cre, fnd]
  sidebar:
    roles: [cre, aut]

# structure example
reference:
  - title: List all available journal templates
    contents:
    - journals
  - title: Journal templates
    contents:
    - ends_with("article")
  - title: Utility function
    desc: Functions useful in templates
    contents:
    - string_to_table