From 857d7a3f6298c130b5febd4fe7435bbac52a3c8d Mon Sep 17 00:00:00 2001
From: debugtalk <mail@debugtalk.com>
Date: Thu, 18 Nov 2021 15:55:51 +0800
Subject: [PATCH] feat: init mkdocs

---
 docs/CHANGELOG.md           |  3 ++
 README.md => docs/README.md |  9 +++---
 docs/installation.md        |  0
 mkdocs.yml                  | 63 +++++++++++++++++++++++++++++++++++++
 4 files changed, 71 insertions(+), 4 deletions(-)
 create mode 100644 docs/CHANGELOG.md
 rename README.md => docs/README.md (97%)
 create mode 100644 docs/installation.md
 create mode 100644 mkdocs.yml

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
new file mode 100644
index 00000000..c784f014
--- /dev/null
+++ b/docs/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Release History
+
+## 0.1.0 (2021-09-01)
diff --git a/README.md b/docs/README.md
similarity index 97%
rename from README.md
rename to docs/README.md
index dd5a195a..b17048d6 100644
--- a/README.md
+++ b/docs/README.md
@@ -10,7 +10,7 @@
 
 ## Key Features
 
-![flow chart](docs/flow.jpg)
+![flow chart](flow.jpg)
 
 - [x] Full support for HTTP(S) requests, more protocols are also in the plan.
 - [x] Testcases can be described in multiple formats, `YAML`/`JSON`/`Golang`, and they are interchangeable.
@@ -57,7 +57,7 @@ Flags:
 Use "hrp [command] --help" for more information about a command.
 ```
 
-You can use `hrp run` command to run HttpRunner JSON/YAML testcases. The following is an example running [examples/demo.json](examples/demo.json)
+You can use `hrp run` command to run HttpRunner JSON/YAML testcases. The following is an example running [examples/demo.json][demo.json]
 
 <details>
 <summary>$ hrp run examples/demo.json</summary>
@@ -236,7 +236,7 @@ func TestCaseDemo(t *testing.T) {
 
 ## Sponsors
 
-[<img src="docs/assets/hogwarts.jpeg" alt="霍格沃兹测试学院" width="500">](https://ceshiren.com/)
+[<img src="assets/hogwarts.jpeg" alt="霍格沃兹测试学院" width="500">](https://ceshiren.com/)
 
 > [霍格沃兹测试开发学社](http://qrcode.testing-studio.com/f?from=httprunner&url=https://ceshiren.com)是业界领先的测试开发技术高端教育品牌，隶属于[测吧（北京）科技有限公司](http://qrcode.testing-studio.com/f?from=httprunner&url=https://www.testing-studio.com) 。学院课程由一线大厂测试经理与资深测试开发专家参与研发，实战驱动。课程涵盖 web/app 自动化测试、接口测试、性能测试、安全测试、持续集成/持续交付/DevOps，测试左移&右移、精准测试、测试平台开发、测试管理等内容，帮助测试工程师实现测试开发技术转型。通过优秀的学社制度（奖学金、内推返学费、行业竞赛等多种方式）来实现学员、学社及用人企业的三方共赢。
 
@@ -249,4 +249,5 @@ func TestCaseDemo(t *testing.T) {
 [allure]: https://docs.qameta.io/allure/
 [HAR]: http://httparchive.org/
 [plugin]: https://pkg.go.dev/plugin
-[examples]: examples/
+[demo.json]: https://github.com/httprunner/hrp/blob/main/examples/demo.json
+[examples]: https://github.com/httprunner/hrp/blob/main/examples/
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 00000000..e69de29b
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 00000000..65fc42c5
--- /dev/null
+++ b/mkdocs.yml
@@ -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 &copy; 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