Commit Graph

11 Commits

Author SHA1 Message Date
Alexander Prinzhorn 231c8eefe3
Update README.md (#4620)
* Document Cookie header folding issues

* plural: *exists*, me: 😮

* link list

* Update README.md

* fair well modd

* minor wording fix

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2021-06-04 09:14:11 +00:00
Maximilian Hils f1a925642f
do not copy hugo's install instructions
that only creates maintenance burden
2021-04-21 12:00:57 +02:00
Jannik 20655fd4e2 docs: add more precise instructions on docs setup 2021-04-11 17:39:47 +02:00
aesyondu 438567f58c
docs(docs-readme): clarify documentation readme (#4538)
* docs(docs-readme): clarify documentation readme

I was confused what `mitmproxy Python package` meant. At first I did `pipx install mitmproxy`, but that didn't work. Then I realized I needed it as a library/module, not cli.

Changed `build.sh` to `build.py` since it was deleted on commit a7d1f32c89

* Update README.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2021-04-06 15:40:13 +02:00
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
Maximilian Hils 05a43572c8 make development setup instructions more clear
Our dev.sh/dev.ps1 scripts feel like an unnecessary layer of abstraction.
The revised docs make the install process transparent to experienced users,
and can also be easily reused for other projects (hi, pdoc!).
2021-01-18 13:56:27 +01:00
Thomas Kriechbaumer 55527c00eb docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
Meet Mangukiya c6393f86d7 Remove yarn/npm from docs
Closes https://github.com/mitmproxy/mitmproxy/issues/3716
2020-02-25 03:38:10 +05:30
Maximilian Hils 68a7d37d53
improve wording 2019-10-13 18:20:38 +02:00
jannst f580e0ea97 hugo server -D fails if html file in docs/src/generated are not present 2019-10-13 17:48:23 +02:00
Maximilian Hils dc3c400b6b add README for docs install 2018-03-20 15:00:29 +01:00