mirror of
https://github.com/httprunner/httprunner.git
synced 2026-05-12 02:21:29 +08:00
64 lines
1.3 KiB
YAML
64 lines
1.3 KiB
YAML
# install mkdocs
|
|
# $ pip install mkdocs # 1.1.2
|
|
# $ pip install mkdocs-material # 5.2.2
|
|
|
|
# usage
|
|
# $ mkdocs serve # build docs and preview
|
|
# $ mkdocs gh-deploy # Deploy your documentation to GitHub Pages
|
|
|
|
# Project information
|
|
site_name: HttpRunner+ Docs
|
|
site_description: HttpRunner+ User Documentation
|
|
site_author: 'debugtalk'
|
|
|
|
# Repository
|
|
repo_name: HttpRunner
|
|
repo_url: https://github.com/httprunner/hrp
|
|
edit_uri: ""
|
|
|
|
# Copyright
|
|
copyright: 'Copyright © 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'
|
|
|
|
# index pages
|
|
nav:
|
|
- README: README.md
|
|
- Installation: installation.md
|
|
- CLI Tools:
|
|
- hrp: cmd/hrp.md
|
|
- hrp_run: cmd/hrp_run.md
|
|
- hrp_har2case: cmd/hrp_har2case.md
|
|
- hrp_boom: cmd/hrp_boom.md
|
|
- CHANGELOG: CHANGELOG.md
|