mirror of
https://github.com/httprunner/httprunner.git
synced 2026-05-17 15:57:36 +08:00
feat: init mkdocs
This commit is contained in:
63
mkdocs.yml
Normal file
63
mkdocs.yml
Normal file
@@ -0,0 +1,63 @@
|
||||
# install mkdocs
|
||||
# $ pip install mkdocs # 1.1.2
|
||||
# $ pip install mkdocs-material # 5.2.2
|
||||
|
||||
# usage
|
||||
# $ mkdocs build # Build the MkDocs documentation
|
||||
# $ mkdocs serve # Run the builtin development server
|
||||
# $ 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:
|
||||
- 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
|
||||
Reference in New Issue
Block a user