diff options
Diffstat (limited to 'docs/src/layouts')
-rw-r--r-- | docs/src/layouts/_default/single.html | 14 | ||||
-rw-r--r-- | docs/src/layouts/index.html | 10 | ||||
-rw-r--r-- | docs/src/layouts/partials/add-anchors.html | 1 | ||||
-rw-r--r-- | docs/src/layouts/partials/edit-on-github.html | 9 | ||||
-rw-r--r-- | docs/src/layouts/partials/outdated.html | 9 | ||||
-rw-r--r-- | docs/src/layouts/partials/sidebar.html | 38 | ||||
-rw-r--r-- | docs/src/layouts/shortcodes/readfile.html | 6 |
7 files changed, 51 insertions, 36 deletions
diff --git a/docs/src/layouts/_default/single.html b/docs/src/layouts/_default/single.html index 4a8baf53..801b6341 100644 --- a/docs/src/layouts/_default/single.html +++ b/docs/src/layouts/_default/single.html @@ -1,10 +1,12 @@ -{{ partial "header.html" . }} -<div class="columns"> - <div class="column is-one-quarter sidebody"> - {{ partial "sidebar.html" . }} +{{ partial "header" . }} +<div class="columns container is-marginless"> + <div id="sidebar" class="column is-one-quarter"> + {{ partial "sidebar" . }} </div> - <div class="column content mainbody"> - {{.Content}} + <div id="main" class="column content"> + {{ partial "outdated" . }} + {{ partial "edit-on-github" . }} + {{ partial "add-anchors" .Content}} </div> </div> {{ partial "footer.html" . }} diff --git a/docs/src/layouts/index.html b/docs/src/layouts/index.html deleted file mode 100644 index 4a8baf53..00000000 --- a/docs/src/layouts/index.html +++ /dev/null @@ -1,10 +0,0 @@ -{{ partial "header.html" . }} -<div class="columns"> - <div class="column is-one-quarter sidebody"> - {{ partial "sidebar.html" . }} - </div> - <div class="column content mainbody"> - {{.Content}} - </div> -</div> -{{ partial "footer.html" . }} diff --git a/docs/src/layouts/partials/add-anchors.html b/docs/src/layouts/partials/add-anchors.html new file mode 100644 index 00000000..f7050f7f --- /dev/null +++ b/docs/src/layouts/partials/add-anchors.html @@ -0,0 +1 @@ +{{ . | replaceRE "(<h[1-9] id=\"(.+?)\".*?>)(.+?</h[1-9]>)" "${1}<a class=\"anchor\" href=\"#${2}\"># </a>${3}" | safeHTML }} diff --git a/docs/src/layouts/partials/edit-on-github.html b/docs/src/layouts/partials/edit-on-github.html new file mode 100644 index 00000000..d2c3098c --- /dev/null +++ b/docs/src/layouts/partials/edit-on-github.html @@ -0,0 +1,9 @@ +{{ if and .IsPage (not (getenv "DOCS_ARCHIVE")) }} +<a class="button is-small is-outlined is-link is-pulled-right" + target="_blank" + href="https://github.com/mitmproxy/mitmproxy/blob/master/docs/src/content/{{ .File.Path }}" +> + Edit on GitHub +</a> +{{ end }} + diff --git a/docs/src/layouts/partials/outdated.html b/docs/src/layouts/partials/outdated.html new file mode 100644 index 00000000..5b3dd6ed --- /dev/null +++ b/docs/src/layouts/partials/outdated.html @@ -0,0 +1,9 @@ +{{- if (getenv "DOCS_ARCHIVE") -}} +<article class="message is-warning"> + <div class="message-body"> + You are not viewing the most up to date version of the documentation. + Click <a href="https://docs.mitmproxy.org/stable{{ .Page.URL }}">here</a> + to view the latest version. + </div> +</article> +{{- end -}} diff --git a/docs/src/layouts/partials/sidebar.html b/docs/src/layouts/partials/sidebar.html index ef853fc6..5ea41c12 100644 --- a/docs/src/layouts/partials/sidebar.html +++ b/docs/src/layouts/partials/sidebar.html @@ -1,24 +1,22 @@ -<div class="sidebar"> - <div class="brand"> - <img src='{{"logo-docs.png" | relURL}}' alt="mitmproxy docs"> - </div> - <div class="version"> - <span class="tag is-info is-rounded is-medium">v3.x</span> - </div> - <aside class="menu"> - <p class="menu-label"> Overview </p> - {{ partial "sidemenu" (dict "ctx" . "menuname" "overview") }} +<div class="brand"> + <a href="https://mitmproxy.org/"> + <img src='{{"logo-docs.png" | relURL}}' alt="mitmproxy docs"/> + </a> - <p class="menu-label">Core concepts</p> - {{ partial "sidemenu" (dict "ctx" . "menuname" "concepts") }} +</div> +<nav class="menu"> + <p class="menu-label"> Overview </p> + {{ partial "sidemenu" (dict "ctx" . "menuname" "overview") }} - <p class="menu-label"> Addon Development </p> - {{ partial "sidemenu" (dict "ctx" . "menuname" "addons") }} + <p class="menu-label">Core concepts</p> + {{ partial "sidemenu" (dict "ctx" . "menuname" "concepts") }} - <p class="menu-label"> HOWTOs </p> - {{ partial "sidemenu" (dict "ctx" . "menuname" "howto") }} + <p class="menu-label"> Addon Development </p> + {{ partial "sidemenu" (dict "ctx" . "menuname" "addons") }} - <p class="menu-label"> Tutorials </p> - {{ partial "sidemenu" (dict "ctx" . "menuname" "tutes") }} - </aside> -</div>
\ No newline at end of file + <p class="menu-label"> HOWTOs </p> + {{ partial "sidemenu" (dict "ctx" . "menuname" "howto") }} + + <p class="menu-label"> Tutorials </p> + {{ partial "sidemenu" (dict "ctx" . "menuname" "tutes") }} +</nav> diff --git a/docs/src/layouts/shortcodes/readfile.html b/docs/src/layouts/shortcodes/readfile.html new file mode 100644 index 00000000..6860b0f1 --- /dev/null +++ b/docs/src/layouts/shortcodes/readfile.html @@ -0,0 +1,6 @@ +{{$file := .Get "file"}} +{{- if eq (.Get "markdown") "true" -}} +{{- $file | readFile | markdownify -}} +{{- else -}} +{{ $file | readFile | safeHTML }} +{{- end -}} |