From ad970ebec285c0a02670783e514a2b4cb316df7d Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 18 Nov 2021 16:17:59 +0800 Subject: [PATCH] change: move README to docs --- README.md => docs/README.md | 28 ++++++++++----------- docs/index.md | 49 ------------------------------------- docs/sponsors.md | 4 +-- mkdocs.yml | 5 +++- 4 files changed, 20 insertions(+), 66 deletions(-) rename README.md => docs/README.md (68%) delete mode 100644 docs/index.md diff --git a/README.md b/docs/README.md similarity index 68% rename from README.md rename to docs/README.md index 88957ff7..9975c04c 100644 --- a/README.md +++ b/docs/README.md @@ -21,24 +21,24 @@ ## Key Features -- Inherit all powerful features of [`requests`][requests], just have fun to handle HTTP(S) in human way. -- Define testcase in YAML or JSON format, run with [`pytest`][pytest] in concise and elegant manner. -- Record and generate testcases with [`HAR`][HAR] support. -- Supports `variables`/`extract`/`validate`/`hooks` mechanisms to create extremely complex test scenarios. -- With `debugtalk.py` plugin, any function can be used in any part of your testcase. -- With [`jmespath`][jmespath], extract and validate json response has never been easier. -- With [`pytest`][pytest], hundreds of plugins are readily available. -- With [`allure`][allure], test report can be pretty nice and powerful. -- With reuse of [`locust`][locust], you can run performance test without extra work. -- CLI command supported, perfect combination with `CI/CD`. +- [x] Inherit all powerful features of [`requests`][requests], just have fun to handle HTTP(S) in human way. +- [x] Define testcase in YAML or JSON format, run with [`pytest`][pytest] in concise and elegant manner. +- [x] Record and generate testcases with [`HAR`][HAR] support. +- [x] Supports `variables`/`extract`/`validate`/`hooks` mechanisms to create extremely complex test scenarios. +- [x] With `debugtalk.py` plugin, any function can be used in any part of your testcase. +- [x] With [`jmespath`][jmespath], extract and validate json response has never been easier. +- [x] With [`pytest`][pytest], hundreds of plugins are readily available. +- [x] With [`allure`][allure], test report can be pretty nice and powerful. +- [x] With reuse of [`locust`][locust], you can run performance test without extra work. +- [x] CLI command supported, perfect combination with `CI/CD`. ## Sponsors -Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](docs/sponsors.md)) +Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](sponsors.md)) ### 金牌赞助商（Gold Sponsor） -[霍格沃兹测试学院](https://ceshiren.com/) +[霍格沃兹测试开发学社](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，测试左移&右移、精准测试、测试平台开发、测试管理等内容，帮助测试工程师实现测试开发技术转型。通过优秀的学社制度（奖学金、内推返学费、行业竞赛等多种方式）来实现学员、学社及用人企业的三方共赢。 @@ -46,7 +46,7 @@ Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](docs/sponsors.md)) ### 开源服务赞助商（Open Source Sponsor） -[Sentry](https://sentry.io/_/open-source/) +[Sentry](https://sentry.io/_/open-source/) HttpRunner is in Sentry Sponsored plan. @@ -54,7 +54,7 @@ HttpRunner is in Sentry Sponsored plan. 关注 HttpRunner 的微信公众号，第一时间获得最新资讯。 -![](docs/assets/qrcode.jpg) +HttpRunner [requests]: http://docs.python-requests.org/en/master/ [pytest]: https://docs.pytest.org/ diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index fabb9740..00000000 --- a/docs/index.md +++ /dev/null @@ -1,49 +0,0 @@ - -# HttpRunner - -[![downloads](https://pepy.tech/badge/httprunner)](https://pepy.tech/project/httprunner) -[![unittest](https://github.com/httprunner/httprunner/workflows/unittest/badge.svg -)](https://github.com/httprunner/httprunner/actions) -[![integration-test](https://github.com/httprunner/httprunner/workflows/integration_test/badge.svg -)](https://github.com/httprunner/httprunner/actions) -[![codecov](https://codecov.io/gh/httprunner/httprunner/branch/master/graph/badge.svg)](https://codecov.io/gh/httprunner/httprunner) -[![pypi version](https://img.shields.io/pypi/v/httprunner.svg)](https://pypi.python.org/pypi/httprunner) -[![pyversions](https://img.shields.io/pypi/pyversions/httprunner.svg)](https://pypi.python.org/pypi/httprunner) -[![TesterHome](https://img.shields.io/badge/TTF-TesterHome-2955C5.svg)](https://testerhome.com/github_statistics) - -*HttpRunner* is a simple & elegant, yet powerful HTTP(S) testing framework. Enjoy! ✨ 🚀 ✨ - -> This docs site is corresponding to the latest version `3.x`, for `2.x` you can reference [`archive link`](https://v2.httprunner.org/). - -## Design Philosophy - -- Convention over configuration -- ROI matters -- Embrace open source, leverage [`requests`][requests], [`pytest`][pytest], [`pydantic`][pydantic], [`allure`][allure] and [`locust`][locust]. - -## Key Features - -- Inherit all powerful features of [`requests`][requests], just have fun to handle HTTP(S) in human way. -- Define testcase in YAML or JSON format, run with [`pytest`][pytest] in concise and elegant manner. -- Record and generate testcases with [`HAR`][HAR] support. -- Supports `variables`/`extract`/`validate`/`hooks` mechanisms to create extremely complex test scenarios. -- With `debugtalk.py` plugin, any function can be used in any part of your testcase. -- With [`jmespath`][jmespath], extract and validate json response has never been easier. -- With [`pytest`][pytest], hundreds of plugins are readily available. -- With [`allure`][allure], test report can be pretty nice and powerful. -- With reuse of [`locust`][locust], you can run performance test without extra work. -- CLI command supported, perfect combination with `CI/CD`. - -## Subscribe - -关注 HttpRunner 的微信公众号，第一时间获得最新资讯。 - -![](/assets/qrcode.jpg) - -[requests]: http://docs.python-requests.org/en/master/ -[pytest]: https://docs.pytest.org/ -[pydantic]: https://pydantic-docs.helpmanual.io/ -[locust]: http://locust.io/ -[jmespath]: https://jmespath.org/ -[allure]: https://docs.qameta.io/allure/ -[HAR]: http://httparchive.org/ diff --git a/docs/sponsors.md b/docs/sponsors.md index de7881f8..0589e271 100644 --- a/docs/sponsors.md +++ b/docs/sponsors.md @@ -4,7 +4,7 @@ ## 金牌赞助商（Gold Sponsor） -[霍格沃兹测试学院](https://ceshiren.com/) +[霍格沃兹测试开发学社](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，测试左移&右移、精准测试、测试平台开发、测试管理等内容，帮助测试工程师实现测试开发技术转型。通过优秀的学社制度（奖学金、内推返学费、行业竞赛等多种方式）来实现学员、学社及用人企业的三方共赢。 @@ -23,4 +23,4 @@ HttpRunner is in Sentry Sponsored plan. | 等级 | 金牌赞助商
（Gold Sponsor） | 银牌赞助商
（Silver Sponsor）| 个人赞赏 | |:---:|:---:|:---:|:---:| | 金额 | ￥20000/年 | ￥8000/年 | 任意 | -| 权益 | 公司 logo（大）和链接展示在 README.md
150 字的宣传文案 | 公司 logo（中）和链接展示在 README.md
50 字的宣传文案| 个人 ID 和链接展示在 sponsors.md | +| 权益 | 公司 logo（大）和链接展示在 README.md
200 字的宣传文案 | 公司 logo（中）和链接展示在 README.md
80 字的宣传文案| 个人 ID 和链接展示在 sponsors.md | diff --git a/mkdocs.yml b/mkdocs.yml index c1c53eaa..bd7817d2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,6 +42,9 @@ markdown_extensions: guess_lang: false - toc: permalink: true + - def_list + - pymdownx.tasklist: + custom_checkbox: true # extra extra: @@ -55,7 +58,7 @@ extra: # index pages nav: - - Introduction: index.md + - README: README.md - Installation: installation.md - User Guide: - Concepts: user/concepts.md