_pkgdown.yml

destination: docs
url: https://fiery.data-imaginist.com

authors:
  Thomas Lin Pedersen:
    href: https://data-imaginist.com

template:
  params:
    bootswatch: simplex

navbar:
  left:
    - icon: fa-home fa-lg
      href: index.html
    - text: Reference
      href: reference/index.html
    - text: Articles
      menu:
      - text: The event cycle
        href: articles/events.html
      - text: Delaying code execution
        href: articles/delayed.html
      - text: Creating and using plugins
        href: articles/plugins.html
      - text: "------------------"
      - text: "Demos"
      - text: "Fiery on Heroku"
        href: https://www.data-imaginist.com/2017/setting-fire-to-deployment/
    - text: News
      menu:
      - text: "Release notes"
      - text: "Version 1.0.0"
        href: https://www.data-imaginist.com/2017/when-a-fire-starts-to-burn/
      - text: "------------------"
      - text: "Change log"
        href: news/index.html
  right:
    - text: reqres
      href: https://reqres.data-imaginist.com
    - text: routr
      href: https://routr.data-imaginist.com
    - icon: fa-github fa-lg
      href: https://github.com/thomasp85/fiery
      
reference:
  - title: "The Fire object"
    desc: >
      fiery is build on top of the R6 class system and all functionality in the
      package is more or less part of the Fire class. The understanding of this
      class is thus integral to understanding fiery.
    contents:
      - Fire
  - title: "Logging"
    desc: >
      Logs are an important part of many servers and fiery has a central logging
      facility where callbacks and handlers can send logging information to 
      without worrying about where and how the logs get written.
    contents:
      - loggers
  - title: "Request and response objects"
    desc: >
      A lot of the logic in web servers are concerned with parsing requests and
      building up responses. fiery uses the Request and Response classes defined
      in the [reqres](https://github.com/thomasp85/reqres) package. See the
      documentation there.
  - title: "Routing"
    desc: >
      A central part of many servers is the router that takes care of recieving
      requests and directing them at the right handlers for further processing. 
      Being the minimal server framework that it is, fiery doesn't include 
      router functionality itself, but the 
      [routr](https://github.com/thomasp85/routr) package.