_pkgdown.yml

navbar:
  structure:
    left: [home, intro, articles, tutorials, reference, news]
  components:
    home:
      text: Home
      icon: fa-home
      href: index.html
    intro:
      text: Get started
      href: huxtable.html
    articles:
      text: Articles
      menu:
      - text: Design Principles, Comparisons and Limitations
        href: design-principles.html
      - text: Regression Tables with huxreg
        href: huxreg.html
    reference:
      text: Reference
      href: reference/index.html
    news:
      text: News
      href: news/index.html

reference:
  - title: "Overview"
    desc: Get high-level documentation about the package
    contents:
      - huxtable-package
      - huxtable-options
      - huxtable-FAQ
      - huxtable-news
      - rowspecs
      - mapping-functions
  - title: "Creating and manipulating huxtables"
    desc: >
      Create, subset, split and join huxtables
    contents:
      - "[.huxtable"
      - add_colnames
      - add_footnote
      - add_rownames
      - cbind.huxtable
      - column_to_header
      - huxtable
      - as_huxtable
      - starts_with("insert")
      - starts_with("split")
      - starts_with("restack")
      - add_rows
      - mutate
      - t.huxtable
  - title: "Size and position"
    desc: Size and position properties
    contents:
      - col_width
      - height
      - position
      - row_height
      - width
  - title: "Table-level properties"
    desc: Other table-level properties
    contents:
      - caption
      - caption_pos
      - caption_width
      - label
      - latex_float
      - tabular_environment
      - table_environment
  - title: "Text properties"
    desc: Style text in table cells
    contents:
      - background_color
      - bold
      - escape_contents
      - starts_with("fmt")
      - font
      - font_size
      - italic
      - markdown
      - set_markdown_contents
      - set_contents
      - number_format
      - na_string
      - starts_with("stripe")
      - text_color
      - starts_with("header")
  - title: "Borders and padding"
    desc: Set borders, border colors and cell padding
    contents:
      - borders
      - border-colors
      - border-styles
      - padding
      - starts_with("set_all")
      - starts_with("set_lr")
      - starts_with("set_tb")
      - starts_with("set_outer")
      - matches("brdr")
  - title: "Layout"
    desc: Change the layout of cells and tables
    contents:
    - align
    - colspan
    - rotation
    - rowspan
    - valign
    - wrap
    - starts_with("merge")
  - title: "Property manipulation"
    desc: Change multiple properties with one command, and set defaults
    contents:
    - starts_with("style")
    - get_default_properties
    - set_default_properties
  - title: "Mapping functions"
    desc: Set cell properties depending on cell contents
    contents:
    - starts_with("by_")
  - title: "Printing"
    desc: Print to LaTeX, HTML, Word, Excel, RTF, markdown or on-screen
    contents:
      - as_flextable
      - as_Workbook
      - guess_knitr_output_format
      - starts_with("print_")
      - print.huxtable
      - knit_print.huxtable
      - knit_print.data.frame
      - rtf_fc_tables
      - starts_with("to_")
  - title: "Quick output"
    desc: Print huxtables or other data to a new file, using a one-liner
    contents:
      - starts_with("quick")
  - title: "Themes"
    desc: Apply a coherent style to a huxtable
    contents:
      - starts_with("theme_")
  - title: "Row specs"
    desc: Specify rows and columns in `set_` functions
    contents:
      - evens
      - everywhere
      - final
      - odds
      - stripe
  - title: "LaTeX dependencies"
    desc: Manage LaTeX packages for huxtable
    contents:
      - matches("latex_dependencies")
  - title: "Regression tables"
    desc: Create a table of regressions
    contents:
      - huxreg
      - tidy_override
      - tidy_replace
  - title: "Miscellaneous"
    desc: Other functions
    contents:
      - hux_logo
      - jams
      - sanitize

tutorials:
  - name: 00-reporting-data
    title: Reporting data with huxtable
    url: https://hughjonesd.github.io/reporting-data-with-huxtable-4.3.0.html
  - name: 01-whats-new
    title: What's new in huxtable 5.0.0
    url: https://hughjonesd.github.io/whats-new-in-huxtable-5.0.0.html
  - name: 02-themes
    title: Huxtable themes
    url: https://hughjonesd.github.io/huxtable/themes.html