Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-22 15:37:45 +00:00
Code Issues Projects Releases Wiki Activity
d0e54bc32c
mitmproxy/docs
History
Peter Dave Hello 123342ea0b
Improve Markdown syntax(styling) (#4496) 
* Improve Markdown syntax

- Add missing blank lines
- Remove trailing spaces
- Remove additional blank lines
- Fix indentation consistency and correctness

* Update addons-examples.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2021-03-11 19:13:02 +01:00
..
bucketassets docs: add robots.txt and error.html 2018-03-05 10:57:50 +13:00
raw few more fixes,picture mod 2018-02-25 22:52:12 +05:30
scripts Refactor docs clirecording Dockerfile (#4484) 2021-03-08 17:18:39 +01:00
src Improve Markdown syntax(styling) (#4496) 2021-03-11 19:13:02 +01:00
.gitignore restructure examples 2020-06-23 16:00:14 +02:00
build.py fix docs CI 2021-02-13 12:29:52 +01:00
ci.sh Improve Shell Script syntax (#4497) 2021-03-11 19:12:03 +01:00
modd.conf docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
README.md Improve Markdown syntax(styling) (#4496) 2021-03-11 19:13:02 +01:00
setup.sh docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
upload-archive.sh Improve Shell Script syntax (#4497) 2021-03-11 19:12:03 +01:00
upload-stable.sh clean doc folder before building, fixes #4405 (#4406) 2021-01-22 01:40:08 +01:00

README.md

Mitmproxy Documentation

This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.

Quick Start

  1. Install hugo.
  2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples.
  3. Make sure the mitmproxy Python package is installed.
  4. Run ./build.sh to generate additional documentation source files.

Now you can run hugo server -D in ./src.

Extended Install

This is required to modify CSS files.

  1. Install "extended" hugo version.

You can now run modd in this directory instead of running hugo directly.