_pkgdown.yml

# SEO:
home:
  # the title of the tab:
  title: Cryptocurrency with R

  # description for google
  description: >
    {cryptoQuotes}: Open access to cryptocurrency market data and
    charts in R.

navbar:
  inverse: true

  structure:
    left:  [intro, usecase, custom-indicators, reference, articles, news]
    right: [search, lightswitch, github]

  components:
    usecase:
      text: Usecase
      href: articles/usecase.html
    custom-indicators:
      text: Custom Indicators
      href: articles/custom_indicators.html
    articles:
      text: Articles
      menu:
        - text: Cryptocurrency Market Data
          href: articles/01-article.html
        - text: Cryptocurrency Charts
          href: articles/02-article.html
        - text: Time Zones
          href: articles/03-article.html
        - text: Converting xts-objects
          href: articles/04-article.html
        - text: '{cryptoQuotes} x {quantmod} and {TTR}'
          href: articles/05-article.html

url: https://serkor1.github.io/cryptoQuotes/

template:
  bootstrap: 5
  light-switch: true
  bslib:
    primary: "#0054AD"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem
    danger: "#A6081A"

reference:
- title: Cryptocurrency Market Data
  desc: >
    The collection of functions to retrieve OHLC-V and sentiment data.
- contents: has_concept('get-functions')

- title: Supported Calls
  desc: >
    The collection of functions to list available argument values in the
    `interval`-, `source`- and `interval`-arguments.
- contents: has_concept('supported calls')

- title: Charting
  desc: >
    The collection of `chart`-functions are split 3; main charts (price chart), main chart
    indicators and subchart indicators. All `charts` are initialised using the `chart`-function.
  contents:
  - chart

- subtitle: Main Charts
  desc: >
    The collection of main chart functions for charting prices.
  contents:
  - kline
  - ohlc
  - pline

- subtitle: Main Chart Indicators
  desc: >
    The collection of main chart indicators which are overlaid the main chart.
  contents:
  - has_concept('main chart indicators')

- subtitle: Subchart Indicators
  desc: >
    The collection of subchart indicators which are charted as a subchart.
  contents:
  - has_concept('subchart indicators')

- title: Utilities
  desc: Manipulate and calibrate objects
- contents: has_concept('utility')

- title: Datasets
  desc: Sample datasets returned by ```get_quote()``` and ```get_fgindex()```
- contents:
  - has_keyword('datasets')