mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-06-17 03:34:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add SPA page for listing modules by their ID

Browse source
This commit is contained in:
Matthew Holt 2020-03-21 21:03:29 -06:00
parent 0834562c9b
commit ca8197d483
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
14 changed files with 565 additions and 392 deletions
Download patch file Download diff file Expand all files Collapse all files

31
src/docs/json/index.html
View file

@ -1,11 +1,12 @@
<!DOCTYPE html>
<html>
<head>
<title>JSON Structure - Caddy Documentation</title>
<title>JSON Config Structure - Caddy Documentation</title>
{{include "/includes/docs-head.html"}}
<link rel="stylesheet" href="/resources/css/docs-json.css">
<script src="/resources/js/marked-0.8.0.min.js"></script>
<script src="/resources/js/docs-json.js"></script>
<script src="/resources/js/docs-api.js"></script>
<script src="/resources/js/json-docs.js"></script>
</head>
<body>
{{include "/includes/docs-header.html"}}
@ -16,36 +17,16 @@
<!--Populated by JS-->
</div>
<pre><code class="json" id="renderbox"><!--Populated by JS--></code></pre>
{{include "/includes/docs-renderbox.html"}}
<article>
<p id="top-doc">
<!--Populated by JS-->
</p>
<h2 id="field-list-header">Field List</h2>
<dl id="field-list">
<!--Populated by JS-->
</dl>
{{include "/includes/docs-details.html"}}
</article>
</div>
<div class="sidebar"></div>
</main>
<div id="hovercard" class="arrow-box">
<div id="hovercard-docs" class="hovercard-elem"><!--Populated by JS--></div>
<div id="hovercard-module" class="hovercard-elem">
<p id="hovercard-namespace-box">
Fulfilled by modules in namespace: <span id="hovercard-namespace"><!--Populated by JS--></span>
</p>
<div id="hovercard-module-list"><!--Populated by JS--></div>
</div>
<div id="hovercard-inline-key" class="hovercard-elem">
<p class="explain">This property is <b>required</b> because it specifies the module name.</p>
</div>
<div id="hovercard-breadcrumb-siblings" class="hovercard-elem"><!--Populated by JS--></div>
<div id="hovercard-inline-link" class="hovercard-elem"><!--Populated by JS--></div>
</div>
{{include "/includes/docs-hovercard.html"}}
{{include "/includes/footer.html"}}
</body>

54
src/docs/modules/index.html Normal file
View file

@ -0,0 +1,54 @@
<!DOCTYPE html>
<html>
<head>
<title>Modules - Caddy Documentation</title>
{{include "/includes/docs-head.html"}}
<link rel="stylesheet" href="/resources/css/docs-json.css">
<script src="/resources/js/marked-0.8.0.min.js"></script>
<script src="/resources/js/docs-api.js"></script>
<script src="/resources/js/module-docs.js"></script>
</head>
<body>
{{include "/includes/docs-header.html"}}
<main>
{{include "/includes/docs-nav.html"}}
<div class="article-container">
<div id="module-list-container">
<article>
<h1>All Modules</h1>
<p>
This page lists all registered Caddy modules.
</p>
<p>
We recommend using your browser's "Find in page" feature for quick lookups.
</p>
<table id="module-list">
<tr>
<th>Module ID</th>
<th>Description</th>
</tr>
<!-- Populated by JS-->
</table>
</article>
</div>
<div id="module-docs-container">
<article>
<h1 id="module-name"><!--Populated by JS--></h1>
</article>
{{include "/includes/docs-renderbox.html"}}
<article>
{{include "/includes/docs-details.html"}}
</article>
</div>
</div>
<div class="sidebar"></div>
</main>
{{include "/includes/docs-hovercard.html"}}
{{include "/includes/footer.html"}}
</body>
</html>