_pkgdown.yml

url: ~

template:
  bootstrap: 5

reference:
  - title: 'The Main Function: `fdt()`'
    desc: >
      The `fdt()` function is the one that takes in your date/time/datetime
      (in whichever way you want to provide it) and provides ways to format
      that input in a flexible manner.
    contents:
    - fdt

  - title: Locales
    desc: >
      You have the option to format dates times according to a specified locale,
      and there are hundreds of locales. The vector object `fdt_locales_vec`
      contains the locale IDs that accepted by `fdt()` and the `fdt_locales_lst`
      list makes selecting a locale in `fdt()` much more convenient (e.g.,
      `locale = fdt_locales_lst$nl_BE`).
    contents:
    - fdt_locales_lst
    - fdt_locales_vec

  - title: Flexible Dates and Times
    desc: >
      Flexible dates and times (divided into 12- and 24-hour variants) embody
      the idea of canonical forms that are translated faithfully across many
      different locales. The vector objects (`*_vec`) show which of these forms
      are available and the list objects (`*_lst`) can be directly used to form
      an input value for `fdt()`'s `format` argument (e.g.,
      `format = flex_t24_lst$Hms`).
    contents:
    - flex_d_lst
    - flex_d_vec
    - flex_t24_lst
    - flex_t24_vec
    - flex_t12_lst
    - flex_t12_vec

  - title: Standard Dates and Times
    desc: >
      Standard dates and times follow the convention of four different types
      ("short", "medium", "long", and "full") that are specially formulated for
      each and every locale. These helper functions provide a simple interface
      for choosing a standardized formatting pattern. Invoke any one of them as
      an input value for `fdt()`'s `format` argument (e.g.,
      `format = standard_date_time(type = "medium")`).
    contents:
    - standard_date_time
    - standard_date
    - standard_time

  - title: Useful Day and Month Vectors
    desc: >
      Sometimes you need to know things about days of the week and months (like,
      their short names). We can get information like that with the
      `names_wkdays()`, `names_months()`, and `first_day_of_week()` functions.
    contents:
    - names_wkdays
    - names_months
    - first_day_of_week