mirror of
https://github.com/caddyserver/website.git
synced 2025-04-20 04:15:04 -04:00
Begin transition to new docs layout
Still need to clean things up and get Quick Assist working again
This commit is contained in:
Matthew Holt
parent
531b39f78d
commit
5f4b630679
5 changed files with 200 additions and 21 deletions
|
|
@ -20,6 +20,13 @@ redir /docs/json /docs/json/
|
||||||
redir /docs/modules /docs/modules/
|
redir /docs/modules /docs/modules/
|
||||||
rewrite /docs/json/* /docs/json/index.html
|
rewrite /docs/json/* /docs/json/index.html
|
||||||
rewrite /docs/modules/* /docs/modules/index.html
|
rewrite /docs/modules/* /docs/modules/index.html
|
||||||
rewrite /docs/* /docs/index.html
|
|
||||||
|
# allow direct access to markdown but otherwise
|
||||||
|
# rewrite to docs index page to render it
|
||||||
|
@notDirectDocsMarkdown {
|
||||||
|
path /docs/*
|
||||||
|
not path *.md
|
||||||
|
}
|
||||||
|
rewrite @notDirectDocsMarkdown /docs/index.html
|
||||||
|
|
||||||
reverse_proxy /api/* localhost:4444
|
reverse_proxy /api/* localhost:4444
|
||||||
|
|
|
||||||
|
|
@ -8,24 +8,187 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>{{$title}} — Caddy Documentation</title>
|
<title>{{$title}} — Caddy Documentation</title>
|
||||||
{{import "/old/includes/docs/head.html"}}
|
{{import "/includes/head.html"}}
|
||||||
{{template "docs-head"}}
|
{{template "head" .}}
|
||||||
<meta property="og:title" content="{{$title}} - Caddy Documentation">
|
<meta property="og:title" content="{{$title}} - Caddy Documentation">
|
||||||
<meta name="twitter:title" value="{{$title}} - Caddy Documentation">
|
<meta name="twitter:title" value="{{$title}} - Caddy Documentation">
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="/resources/css/docs.css{{template "cacheBust"}}">
|
||||||
|
|
||||||
|
<script src="/resources/js/vendor/marked.min.js{{template "cacheBust"}}"></script>
|
||||||
|
<script src="/resources/js/docs.js{{template "cacheBust"}}"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
{{include "/old/includes/docs/header.html"}}
|
{{include "/includes/header.html" ""}}
|
||||||
|
|
||||||
|
<div id="autonav"></div>
|
||||||
|
|
||||||
<main>
|
<main>
|
||||||
{{include "/old/includes/docs/nav.html"}}
|
<div class="docs wrapper">
|
||||||
<div class="article-container">
|
<nav>
|
||||||
<div class="paper" id="paper1"></div>
|
<div id="docs-menu">
|
||||||
<div class="paper" id="paper2"></div>
|
<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-menu-2" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||||||
<div class="paper paper3">
|
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
|
||||||
<article>{{markdown $markdownFile.Body}}</article>
|
<path d="M4 6l16 0"></path>
|
||||||
</div>
|
<path d="M4 12l16 0"></path>
|
||||||
|
<path d="M4 18l16 0"></path>
|
||||||
|
</svg>
|
||||||
|
Pages
|
||||||
|
</div>
|
||||||
|
<div id="docs-menu-container">
|
||||||
|
<ul>
|
||||||
|
<li class="heading">Get Caddy</li>
|
||||||
|
<li>
|
||||||
|
<a href="/docs/install" class="current">Install</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/docs/install/packages">OS packages</a></li>
|
||||||
|
<li><a href="/docs/install/downloads">Static binaries</a></li>
|
||||||
|
<li><a href="/docs/install/plugins">With plugins</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href="/docs/build">Build from source</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li class="heading">Tutorials</li>
|
||||||
|
<li><a href="/docs/basics">Caddy basics</a></li>
|
||||||
|
<li><a href="/docs/troubleshooting">How to fix problems</a></li>
|
||||||
|
<li><a href="/docs/static-files">Static files</a></li>
|
||||||
|
<li><a href="/docs/reverse-proxy">Reverse proxy</a></li>
|
||||||
|
<li><a href="/docs/reverse-proxy">Custom domains</a></li>
|
||||||
|
<li><a href="/docs/reverse-proxy">Automate mTLS</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li class="heading">Reference</li>
|
||||||
|
<li><a href="/docs/command-line">Command line</a></li>
|
||||||
|
<li><a href="/docs/api">API</a></li>
|
||||||
|
<li><a href="/docs/json/">JSON config</a></li>
|
||||||
|
<li>
|
||||||
|
<a href="/docs/caddyfile">Caddyfile</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/docs/caddyfile/concepts">Concepts</a></li>
|
||||||
|
<li><a href="/docs/caddyfile/directives">Directives</a></li>
|
||||||
|
<li><a href="/docs/caddyfile/matchers">Request matchers</a></li>
|
||||||
|
<li><a href="/docs/caddyfile/options">Global options</a></li>
|
||||||
|
<li><a href="/docs/caddyfile/patterns">Common patterns</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<!-- <li><a href="/docs/caddyfile">Caddyfile</a></li> -->
|
||||||
|
<li><a href="/docs/automatic-https">Automatic HTTPS</a></li>
|
||||||
|
<li><a href="/docs/automatic-https">Modules</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li class="heading">Articles</li>
|
||||||
|
<!-- <li><a href="/docs/v2-upgrade">Upgrading to Caddy 2</a></li> -->
|
||||||
|
<li><a href="/docs/conventions">Conventions</a></li>
|
||||||
|
<li><a href="/docs/config-adapters">Config Adapters</a></li>
|
||||||
|
<li><a href="/docs/logging">How Logging Works</a></li>
|
||||||
|
<li><a href="/docs/metrics">Monitoring Caddy</a></li>
|
||||||
|
<li><a href="/docs/architecture">Caddy Architecture</a></li>
|
||||||
|
<li><a href="/docs/running">Keep Caddy Running</a></li>
|
||||||
|
<li><a href="/docs/signature-verification">Verifying Asset Signatures</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li class="heading">Develop</li>
|
||||||
|
<li><a href="/docs/architecture">Caddy architecture</a></li>
|
||||||
|
<li><a href="/docs/contribute">Contribute</a></li>
|
||||||
|
<li><a href="/docs/extend">Write a module</a></li>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<article>
|
||||||
|
<!-- TODO: This should only be on the docs homepage. Also, I can't get it to work. lol -->
|
||||||
|
<div class="fullspan">
|
||||||
|
{{ include "/includes/quick-assist/core.html" }}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{{markdown $markdownFile.Body}}
|
||||||
|
|
||||||
|
<h1>Documentation</h1>
|
||||||
|
|
||||||
|
<div class="fullspan">
|
||||||
|
{{ include "/includes/quick-assist/core.html" }}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- TODO: Playing with ideas for the new docs homepage -->
|
||||||
|
|
||||||
|
<!-- <div class="box">
|
||||||
|
<h3>Getting Started</h3>
|
||||||
|
<p>
|
||||||
|
New here? Welcome! As usual, before running any server software, please make sure you:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>know how to use your terminal / command line</li>
|
||||||
|
<li>are familiar with installing and using non-graphical software</li>
|
||||||
|
<li>can edit text files to configure programs</li>
|
||||||
|
<li>understand how your operating system's network stack and permissions model work</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="box">
|
||||||
|
<h3>Caddyfile Directives</h3>
|
||||||
|
<p>
|
||||||
|
Quick access to all standard Caddyfile directives:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/abort">abort</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/acme_server">acme_server</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/basicauth">basicauth</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/bind">bind</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/encode">encode</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/error">error</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/file_server">file_server</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/forward_auth">forward_auth</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/handle">handle</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/handle_errors">handle_errors</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/handle_path">handle_path</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/header">header</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/import">import</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/log">log</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/map">map</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/method">method</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/metrics">metrics</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/php_fastcgi">php_fastcgi</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/push">push</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/redir">redir</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/request_body">request_body</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/request_header">request_header</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/respond">respond</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/reverse_proxy">reverse_proxy</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/rewrite">rewrite</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/root">root</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/route">route</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/skip_log">skip_log</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/templates">templates</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/tls">tls</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/tracing">tracing</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/try_files">try_files</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/uri">uri</a></code></li>
|
||||||
|
<li><code><a href="/docs/caddyfile/directives/vars">vars</a></code></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="box">
|
||||||
|
<h3>Examples</h3>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div> -->
|
||||||
|
<!-- </div> -->
|
||||||
|
|
||||||
|
|
||||||
|
{{markdown $markdownFile.Body}}
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<nav id="pagenav">
|
||||||
|
<div class="heading">On this page</div>
|
||||||
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
<div class="sidebar"></div>
|
|
||||||
</main>
|
</main>
|
||||||
{{include "/old/includes/footer.html"}}
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
||||||
|
|
@ -55,7 +55,6 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li class="dropdown-trigger">
|
<li class="dropdown-trigger">
|
||||||
<a href="/docs/">Documentation</a>
|
<a href="/docs/">Documentation</a>
|
||||||
<!--
|
|
||||||
<div class="dropdown">
|
<div class="dropdown">
|
||||||
<div class="row flatlinks">
|
<div class="row flatlinks">
|
||||||
<a href="/docs/install">
|
<a href="/docs/install">
|
||||||
|
|
@ -122,7 +121,7 @@
|
||||||
<a href="javascript:">Directives</a>
|
<a href="javascript:">Directives</a>
|
||||||
<a href="javascript:">Request matchers</a>
|
<a href="javascript:">Request matchers</a>
|
||||||
<a href="javascript:">Global options</a>
|
<a href="javascript:">Global options</a>
|
||||||
</div> -- >
|
</div> -->
|
||||||
<div class="col">
|
<div class="col">
|
||||||
<div class="links-header">Develop</div>
|
<div class="links-header">Develop</div>
|
||||||
<a href="javascript:">Architecture</a>
|
<a href="javascript:">Architecture</a>
|
||||||
|
|
@ -138,7 +137,7 @@
|
||||||
<a href="javascript:">All articles...</a>
|
<a href="javascript:">All articles...</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<!-- Make a new linkbox div for a separate section. -- >
|
<!-- Make a new linkbox div for a separate section. -->
|
||||||
</div>
|
</div>
|
||||||
<div class="row featured">
|
<div class="row featured">
|
||||||
<a href="/docs/install">
|
<a href="/docs/install">
|
||||||
|
|
@ -170,7 +169,7 @@
|
||||||
<path d="M19.875 6.27c.7 .398 1.13 1.143 1.125 1.948v7.284c0 .809 -.443 1.555 -1.158 1.948l-6.75 4.27a2.269 2.269 0 0 1 -2.184 0l-6.75 -4.27a2.225 2.225 0 0 1 -1.158 -1.948v-7.285c0 -.809 .443 -1.554 1.158 -1.947l6.75 -3.98a2.33 2.33 0 0 1 2.25 0l6.75 3.98h-.033z"></path>
|
<path d="M19.875 6.27c.7 .398 1.13 1.143 1.125 1.948v7.284c0 .809 -.443 1.555 -1.158 1.948l-6.75 4.27a2.269 2.269 0 0 1 -2.184 0l-6.75 -4.27a2.225 2.225 0 0 1 -1.158 -1.948v-7.285c0 -.809 .443 -1.554 1.158 -1.947l6.75 -3.98a2.33 2.33 0 0 1 2.25 0l6.75 3.98h-.033z"></path>
|
||||||
<path d="M12 16v.01"></path>
|
<path d="M12 16v.01"></path>
|
||||||
<path d="M12 13a2 2 0 0 0 .914 -3.782a1.98 1.98 0 0 0 -2.414 .483"></path>
|
<path d="M12 13a2 2 0 0 0 .914 -3.782a1.98 1.98 0 0 0 -2.414 .483"></path>
|
||||||
</svg> -- >
|
</svg> -->
|
||||||
FAQ
|
FAQ
|
||||||
</b>
|
</b>
|
||||||
Get fast answers to common questions
|
Get fast answers to common questions
|
||||||
|
|
@ -196,7 +195,6 @@
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
-->
|
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="/features">Features</a>
|
<a href="/features">Features</a>
|
||||||
|
|
|
||||||
|
|
@ -264,7 +264,7 @@ main nav li ul {
|
||||||
|
|
||||||
|
|
||||||
article {
|
article {
|
||||||
font-family: 'Albert Sans', system-ui; /* considered: Figtree, Asisstant, Red Hat Text, Be Vietnam Pro
|
font-family: 'Albert Sans', Figree, Assistant, 'Red Hat Text', 'Be Vietnam Pro', system-ui;
|
||||||
font-size: 20px;
|
font-size: 20px;
|
||||||
word-wrap: break-word;
|
word-wrap: break-word;
|
||||||
|
|
||||||
|
|
@ -772,7 +772,11 @@ h3.quick-assist-question {
|
||||||
min-height: 3.5em;
|
min-height: 3.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
main nav li img,
|
||||||
|
article li img,
|
||||||
|
img.external-link {
|
||||||
|
max-height: .9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -49,7 +49,14 @@ ready(function() {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const response = await fetch("/temporary-markdown-proxy"+e.target.getAttribute('href'));
|
// transform user-facing URL to direct link to markdown file for the hover submenu
|
||||||
|
let href = e.target.getAttribute('href');
|
||||||
|
const trimPrefix = "/docs/";
|
||||||
|
if (href.startsWith(trimPrefix)) {
|
||||||
|
href = href.slice(trimPrefix.length);
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await fetch(`/docs/markdown/${href}.md`);
|
||||||
const markdown = await response.text();
|
const markdown = await response.text();
|
||||||
const tokens = marked.lexer(markdown);
|
const tokens = marked.lexer(markdown);
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue