mkdocs.yml

site_name: 'Image-Charts documentation'
site_author: 'François-Guillaume Ribreau'
site_url: "https://documentation.image-charts.com"

main_site_name: Image-Charts
main_site_url: "https://www.image-charts.com"

# Repository
# repo_name: image-charts/documentation
# repo_url: https://github.com/image-charts/documentation
edit_uri: "https://github.com/image-charts/documentation/edit/master/docs"


docs_dir: 'docs'
extra_css:
  - _css/styles.css
extra_javascript:
  - _js/editor.js

# do not use google analytics parameter, rely on google tag manager instead

# Copyright
# copyright: 'Copyright © Image-Charts'

nav:
  - Getting started: index.md
  - Bar Charts: bar-charts.md
  - Line Charts: line-charts.md
  - Sparkline Charts: /line-charts/#sparklines
  - Scatter Charts: /line-charts/#scatter
  - Pie Charts: pie-charts.md
  - Doughnut Charts: /pie-charts#doughnut
  - Polar Charts: polar-charts.md
  - Radar Charts: radar-charts.md
  - Bubble Charts: bubble-charts.md
  - GraphViz Charts: graph-viz-charts.md
  - Progress Bar Charts: progress-bar-charts.md
  - QR Codes: qr-codes.md
  - Chart.js: chart.js.md
  - Reference:
      - Chart Type: reference/chart-type.md
      - Chart Size: reference/chart-size.md
      - Data Format: reference/data-format.md
      - Color Format: reference/color-format.md
      - Title: reference/chart-title.md
      - Grid Lines: reference/grid-lines.md
      - Labels: reference/chart-label.md
      - Markers : reference/markers.md
      - Margins: reference/chart-margin.md
      - Axis: reference/chart-axis.md
      - Legend: reference/legend-text-and-style.md
      - Font: reference/chart-font.md
      - Background: reference/background-fill.md
      - Gif animation: reference/animation.md
      - Output Format: reference/output-format.md
      - POST requests: reference/post-requests.md
      - Retina support: reference/retina.md
      - Localization: reference/localization.md
  - Guides:
      - How to setup a dependency graph in Google Sheets: guides/graph-in-google-sheets.md
      - How to send charts to a Slack channel: guides/send-charts-to-slack.md
      - How to generate image charts from Salesforce Apex language: guides/salesforce-apex-charts.md
      - How to send a radar chart by email from typeform: guides/charts-from-typeform.md
  - Gallery: gallery.md
  - Enterprise: enterprise.md
  - SDK & libraries: sdk-and-libraries.md
  - On Premise: on-premise.md
  - Errors: errors.md
  - Limits and Quotas: limits-and-quotas.md

  - Status Page: https://status.image-charts.com
  - Changelog: https://headwayapp.co/image-charts-changelog
  - Static Chart Editor: https://editor.image-charts.com

# Configuration
theme:
  # https://github.com/squidfunk/mkdocs-material
  name: "material"
  custom_dir: "theme"

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  feature:
    tabs: false
  palette:
    primary: indigo
    accent: blue
  font:
    text: Roboto
    code: Roboto Mono
  favicon: 'logo/rgb-rect-white@32.png'
  logo: 'logo/rgb-bw@512.png'

extra:
  social:
    - icon: "fontawesome/brands/github-alt"
      link: "https://github.com/image-charts"
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/imagecharts"
    - icon: "fontawesome/solid/envelope"
      link: "mailto:support@image-charts.com"

plugins:
  - search
  - minify:
      minify_html: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
      js_files:
        - _js/editor.js

# facelessuser.github.io/pymdown-extensions
# https://www.mkdocs.org/user-guide/configuration/#formatting-options
# https://github.com/facelessuser/pymdown-extensions/blob/master/mkdocs.yml#L96
markdown_extensions:
  - pymdownx.inlinehilite
  - pymdownx.emoji
  # https://github.com/mkdocs/mkdocs/issues/777#issuecomment-308266201
  - markdown_include.include:
      base_path: docs
  # https://facelessuser.github.io/pymdown-extensions/extensions/superfences/#nested-fence-format
  - pymdownx.tabbed
  - pymdownx.snippets:
      base_path: docs/
  - pymdownx.superfences:
      preserve_tabs: true
  - pymdownx.critic
  - pymdownx.tilde
  - pymdownx.tasklist
  - pymdownx.smartsymbols
  # https://squidfunk.github.io/mkdocs-material/extensions/admonition
  - markdown.extensions.admonition
  - markdown.extensions.attr_list