# install mkdocs and material design
# $ pip install mkdocs-material

# usage
# $ mkdocs serve        # build docs and preview
# $ mkdocs gh-deploy    # Deploy your documentation to GitHub Pages

# Project information
site_name: HttpRunner V3.x Docs
site_description: HttpRunner V3.x User Documentation
site_author: 'debugtalk'

# Repository
repo_name: HttpRunner
repo_url: https://github.com/httprunner/httprunner
edit_uri: ""

# Copyright
copyright: 'Copyright © 2017 - 2021 debugtalk'

# Configuration
theme:
    name: 'material'
    language: 'zh'
    palette:
        primary: 'indigo'
        accent: 'indigo'
    font:
        text: 'Roboto'
        code: 'Roboto Mono'

# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

# extra
extra:
    search:
        language: 'jp'
    social:
        -   icon: material/library
            link: https://debugtalk.com
        -   icon: fontawesome/brands/github-alt
            link: 'https://github.com/httprunner'
    analytics:
        provider: google # Google Analytics
        property: UA-114587036-3

# index pages
nav:
    - README: README.md
    - Installation: installation.md
    - User Guide:
        - Concepts: user/concepts.md
        - Scaffold: user/scaffold.md
        - Record & Generate testcase: user/gen_tests.md
        - Write Testcase: user/write_testcase.md
        - Run Testcase: user/run_testcase.md
        - Testing Report: user/testing_report.md
        - Run load test: user/run_loadtest.md
    - Sponsors: sponsors.md
    - CHANGELOG: CHANGELOG.md