Commit Graph

39 Commits

Author SHA1 Message Date
Maximilian Hils
615d606da9
docs: minor improvements to Windows installation 2018-05-16 15:35:37 +02:00
Aldo Cortesi
dc2ac88871 docs: complete, informative documentation on our SOCKS5 mode 2018-05-16 10:15:54 +12:00
Aldo Cortesi
17dd7e2bd6 docs: installation, WSL 2018-05-16 10:07:03 +12:00
Aldo Cortesi
56010ebcb7 docs: clarify binary packaage admonition 2018-05-15 10:46:30 +12:00
Aldo Cortesi
2db223decb docs: console key binding docs and example 2018-05-15 10:34:55 +12:00
Aldo Cortesi
fe4c371001 docs: split out tool documentation 2018-05-15 10:07:09 +12:00
Aldo Cortesi
9830e5b597 cadir -> confdir
We store a lot more than just the CAs in our configuration directory. Clarify
the option name.
2018-05-10 11:40:33 +12:00
Thomas Kriechbaumer
44d788ff96
Merge pull request #2986 from miheerdew/patch-1
Workaround for MacOS transparent proxy
2018-05-06 12:24:24 +02:00
Simon Elvery
48ba4eb737
Fix typo in addons-overview.md 2018-05-05 20:24:49 +10:00
p1uymi
93a59acaeb
Changed syntax from v2 to v3
--client-certs = v2 syntax --> --set client_certs=value = v3 syntax
--cadir = v2 syntax --> --set cadir=value = v3 syntax
2018-04-26 16:14:27 +02:00
Maximilian Hils
660aa87a24
fix GA id 2018-04-11 16:58:09 -06:00
Aldo Cortesi
53827a36ae
Merge pull request #3025 from Kriechi/py36
Python 3.5 is dead -- long live Python 3.6!
2018-04-01 08:59:47 +12:00
ghillu
673b58c79f
Update addons-overview.md
Fixed a typo
2018-04-01 00:09:45 +05:30
Thomas Kriechbaumer
46f8901b8c Python 3.5 is dead -- long live Python 3.6!
fixes #2266
2018-03-31 18:46:32 +02:00
Aldo Cortesi
3c52ed6ee1
Merge pull request #3012 from Kriechi/docs-options
docs: add auto-generated options reference
2018-03-30 09:38:17 +13:00
Michael Shi
f6b616aa89
Fixed Typo in Transparent Proxy Setup for Mac
Fixed typo referencing `en2` when it should mention `en0`
2018-03-26 21:30:14 -07:00
Thomas Kriechbaumer
f6699792da docs: add auto-generated options reference 2018-03-25 13:42:55 +02:00
Miheer Dewaskar
9ee96f0227 Merge master 2018-03-24 10:49:08 -04:00
Maximilian Hils
4eb6954c7d various docs improvements
- add clickable anchors for headers
- add "outdated" warning for archived docs
- add "edit on github" button
- beautify template
2018-03-21 00:42:37 +01:00
Maximilian Hils
9748487939 improve transparent mode docs 2018-03-20 16:00:23 +01:00
Maximilian Hils
252684e14e minor docs fixes 2018-03-20 16:00:02 +01:00
Maximilian Hils
885d3d5da4 add google analytics 2018-03-20 15:58:48 +01:00
Miheer Dewaskar
00d51db925
Spelling 2018-03-11 19:03:45 -04:00
Miheer Dewaskar
d866b959fe
Extrac comment and typo 2018-03-11 19:01:14 -04:00
Miheer Dewaskar
6f802274c1
Workaround for MacOS transparent proxy
This workaround (adopted from #1261) allows MacOS users to redirect their machine's outgoing traffic to mitmproxy transparently.
2018-03-11 18:55:53 -04:00
Aldo Cortesi
08e50aa39b docs: port changes in .css to .scss source 2018-03-05 10:09:18 +13:00
Aldo Cortesi
5297e66a87
Merge pull request #2949 from Kriechi/docs-protocols
docs: add protocols description
2018-03-05 09:10:37 +13:00
Maximilian Hils
47f3a61a5c
Merge pull request #2948 from Kriechi/docs-sidebar-height
render sidebar without height limit
2018-03-04 19:46:00 +01:00
Thomas Kriechbaumer
618bd31bd8 docs: add protocols description 2018-03-03 13:36:06 +01:00
Thomas Kriechbaumer
f3a27e2779 render sidebar without height limit 2018-03-03 13:03:14 +01:00
Thomas Kriechbaumer
b4440c4252 make sidebar visually distinct 2018-03-03 13:00:20 +01:00
Thomas Kriechbaumer
a074a1df40 readd Wireshark SSL master secrets docs 2018-03-02 23:03:54 +01:00
Maximilian Hils
7eadd0c6ba
Merge pull request #2920 from kira0204/docs-2913
Docs updates
2018-02-25 18:32:15 +01:00
kira0204
302bf9875b trans-1 update 2018-02-25 23:00:09 +05:30
kira0204
93ce72d0b1 few more fixes,picture mod 2018-02-25 22:52:12 +05:30
Aldo Cortesi
0d43bb550a
Merge pull request #2914 from kira0204/docs-2913
Updating docs
2018-02-25 10:09:45 +13:00
kira0204
f31ce49aa5 Fixing #2913 2018-02-24 23:47:55 +05:30
Monami Sharma
35fadd10bf
Spelling corrected for think*
Replaced "You should thin* of the mitmproxy" to "You should think* of the mitmproxy"
2018-02-24 11:12:57 -06:00
Aldo Cortesi
982508d30f All new documentation
This patch does a lot.

- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.

With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.

With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 18:07:58 +13:00