Skip to content

Commit 512f408

Browse files
author
Retype GitHub Action
committed
Refreshes Retype-generated documentation.
Process triggered by smcnab1.
1 parent b06cfab commit 512f408

File tree

6 files changed

+27
-105
lines changed

6 files changed

+27
-105
lines changed

404.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/project-template-repo">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757446861133">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757447119108">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -28,11 +28,11 @@
2828

2929
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3030

31-
<link href="/project-template-repo/resources/css/retype.css?v=3.5.0.757446861133" rel="stylesheet">
31+
<link href="/project-template-repo/resources/css/retype.css?v=3.5.0.757447119108" rel="stylesheet">
3232

33-
<script data-cfasync="false" src="/project-template-repo/resources/js/config.js?v=3.5.0.757446861133" data-turbo-eval="false" defer></script>
33+
<script data-cfasync="false" src="/project-template-repo/resources/js/config.js?v=3.5.0.757447119108" data-turbo-eval="false" defer></script>
3434
<script data-cfasync="false" src="/project-template-repo/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
35-
<script id="lunr-js" data-cfasync="false" src="/project-template-repo/resources/js/lunr.js?v=3.5.0.757446861133" data-turbo-eval="false" defer></script>
35+
<script id="lunr-js" data-cfasync="false" src="/project-template-repo/resources/js/lunr.js?v=3.5.0.757447119108" data-turbo-eval="false" defer></script>
3636
</head>
3737
<body>
3838
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

index.html

Lines changed: 21 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,38 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/project-template-repo">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757446861133">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757447119108">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
1111

1212
<!-- Primary Meta Tags -->
13-
<title>Welcome</title>
14-
<meta name="title" content="Welcome">
15-
<meta name="description" content="✅ Your website is working.">
13+
<title>Page with header</title>
14+
<meta name="title" content="Page with header">
15+
<meta name="description" content="This is a page with a top feature image as the header.">
1616

1717
<!-- Canonical -->
1818
<link rel="canonical" href="https://smcnab1.github.io/project-template-repo/">
1919

2020
<!-- Open Graph / Facebook -->
2121
<meta property="og:type" content="website">
2222
<meta property="og:url" content="https://smcnab1.github.io/project-template-repo/">
23-
<meta property="og:title" content="Welcome">
24-
<meta property="og:description" content="✅ Your website is working.">
23+
<meta property="og:title" content="Page with header">
24+
<meta property="og:description" content="This is a page with a top feature image as the header.">
2525

2626
<!-- Twitter -->
2727
<meta property="twitter:card" content="summary_large_image">
2828
<meta property="twitter:url" content="https://smcnab1.github.io/project-template-repo/">
29-
<meta property="twitter:title" content="Welcome">
30-
<meta property="twitter:description" content="✅ Your website is working.">
29+
<meta property="twitter:title" content="Page with header">
30+
<meta property="twitter:description" content="This is a page with a top feature image as the header.">
3131

3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

34-
<link href="resources/css/retype.css?v=3.5.0.757446861133" rel="stylesheet">
34+
<link href="resources/css/retype.css?v=3.5.0.757447119108" rel="stylesheet">
3535

36-
<script data-cfasync="false" src="resources/js/config.js?v=3.5.0.757446861133" data-turbo-eval="false" defer></script>
36+
<script data-cfasync="false" src="resources/js/config.js?v=3.5.0.757447119108" data-turbo-eval="false" defer></script>
3737
<script data-cfasync="false" src="resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
38-
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=3.5.0.757446861133" data-turbo-eval="false" defer></script>
39-
<script id="prism-js" data-cfasync="false" src="resources/js/prism.js?v=3.5.0.757446861133" defer></script>
38+
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=3.5.0.757447119108" data-turbo-eval="false" defer></script>
4039
</head>
4140
<body>
4241
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
@@ -165,90 +164,18 @@
165164
<!-- Rendered if sidebar right is enabled -->
166165
<div id="docs-sidebar-right-toggle"></div>
167166
<!-- Page content -->
168-
<doc-anchor-target id="welcome" class="break-words">
167+
<p><figure class="content-center">
168+
<img src="page-with-header.png" alt="">
169+
<figcaption class="caption"></figcaption>
170+
</figure>
171+
</p>
172+
<doc-anchor-target id="page-with-header" class="break-words">
169173
<h1>
170-
<doc-anchor-trigger class="header-anchor-trigger" to="#welcome">#</doc-anchor-trigger>
171-
<span>Welcome</span>
174+
<doc-anchor-trigger class="header-anchor-trigger" to="#page-with-header">#</doc-anchor-trigger>
175+
<span>Page with header</span>
172176
</h1>
173177
</doc-anchor-target>
174-
<p><span class="docs-emoji">&#x2705;</span> Your website is working.</p>
175-
<p><strong>but... this is a placeholder <mark>Welcome</mark> page.</strong></p>
176-
<p>To replace this placeholder page, create a <code v-pre>readme.md</code> file and add it to the root of your project.</p>
177-
<div class="flex mb-6">
178-
<div class="shrink-0 w-1 rounded-tl rounded-bl bg-blue-500 dark:bg-blue-400"></div>
179-
<div class="flex w-full py-4 border border-l-0 border-gray-300 rounded-tr rounded-br doc-alert bg-white dark:bg-dark-700 dark:border-dark-700" role="alert">
180-
<div class="flex items-center ml-4 h-7">
181-
<svg xmlns="http://www.w3.org/2000/svg" class="mb-px text-blue-500 dark:text-blue-400" width="22" height="22" viewBox="0 0 24 24" role="presentation">
182-
<g fill="currentColor"><g>
183-
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
184-
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
185-
<path fill="none" d="M0 0h24v24H0z"></path>
186-
</g></g>
187-
</svg>
188-
</div>
189-
<div class="pr-5 ml-3 w-full">
190-
<p>You can name the file <code v-pre>index.md</code>, <code v-pre>default.md</code>, <code v-pre>readme.md</code>, or <code v-pre>welcome.md</code>.</p>
191-
</div>
192-
</div>
193-
</div>
194-
<doc-anchor-target id="settings">
195-
<h2>
196-
<doc-anchor-trigger class="header-anchor-trigger" to="#settings">#</doc-anchor-trigger>
197-
<span>Settings <svg xmlns="http://www.w3.org/2000/svg" class="docs-icon" viewBox="0 0 24 24" role="presentation"><g fill="currentColor"><g><path d="M16 12a4 4 0 1 1-8 0 4 4 0 0 1 8 0Zm-1.5 0a2.5 2.5 0 1 0-5 0 2.5 2.5 0 0 0 5 0Z"/><path d="M12 1c.266 0 .532.009.797.028.763.055 1.345.617 1.512 1.304l.352 1.45c.019.078.09.171.225.221.247.089.49.19.728.302.13.061.246.044.315.002l1.275-.776c.603-.368 1.411-.353 1.99.147.402.349.78.726 1.128 1.129.501.578.515 1.386.147 1.99l-.776 1.274c-.042.069-.058.185.002.315.112.238.213.481.303.728.048.135.142.205.22.225l1.45.352c.687.167 1.249.749 1.303 1.512.038.531.038 1.063 0 1.594-.054.763-.616 1.345-1.303 1.512l-1.45.352c-.078.019-.171.09-.221.225-.089.248-.19.491-.302.728-.061.13-.044.246-.002.315l.776 1.275c.368.603.353 1.411-.147 1.99-.349.402-.726.78-1.129 1.128-.578.501-1.386.515-1.99.147l-1.274-.776c-.069-.042-.185-.058-.314.002a8.606 8.606 0 0 1-.729.303c-.135.048-.205.142-.225.22l-.352 1.45c-.167.687-.749 1.249-1.512 1.303-.531.038-1.063.038-1.594 0-.763-.054-1.345-.616-1.512-1.303l-.352-1.45c-.019-.078-.09-.171-.225-.221a8.138 8.138 0 0 1-.728-.302c-.13-.061-.246-.044-.315-.002l-1.275.776c-.603.368-1.411.353-1.99-.147-.402-.349-.78-.726-1.128-1.129-.501-.578-.515-1.386-.147-1.99l.776-1.274c.042-.069.058-.185-.002-.314a8.606 8.606 0 0 1-.303-.729c-.048-.135-.142-.205-.22-.225l-1.45-.352c-.687-.167-1.249-.749-1.304-1.512a11.158 11.158 0 0 1 0-1.594c.055-.763.617-1.345 1.304-1.512l1.45-.352c.078-.019.171-.09.221-.225.089-.248.19-.491.302-.728.061-.13.044-.246.002-.315l-.776-1.275c-.368-.603-.353-1.411.147-1.99.349-.402.726-.78 1.129-1.128.578-.501 1.386-.515 1.99-.147l1.274.776c.069.042.185.058.315-.002.238-.112.481-.213.728-.303.135-.048.205-.142.225-.22l.352-1.45c.167-.687.749-1.249 1.512-1.304C11.466 1.01 11.732 1 12 1Zm-.69 1.525c-.055.004-.135.05-.161.161l-.353 1.45a1.832 1.832 0 0 1-1.172 1.277 7.147 7.147 0 0 0-.6.249 1.833 1.833 0 0 1-1.734-.074l-1.274-.776c-.098-.06-.186-.036-.228 0a9.774 9.774 0 0 0-.976.976c-.036.042-.06.131 0 .228l.776 1.274c.314.529.342 1.18.074 1.734a7.147 7.147 0 0 0-.249.6 1.831 1.831 0 0 1-1.278 1.173l-1.45.351c-.11.027-.156.107-.16.162a9.63 9.63 0 0 0 0 1.38c.004.055.05.135.161.161l1.45.353a1.832 1.832 0 0 1 1.277 1.172c.074.204.157.404.249.6.268.553.24 1.204-.074 1.733l-.776 1.275c-.06.098-.036.186 0 .228.301.348.628.675.976.976.042.036.131.06.228 0l1.274-.776a1.83 1.83 0 0 1 1.734-.075c.196.093.396.176.6.25a1.831 1.831 0 0 1 1.173 1.278l.351 1.45c.027.11.107.156.162.16a9.63 9.63 0 0 0 1.38 0c.055-.004.135-.05.161-.161l.353-1.45a1.834 1.834 0 0 1 1.172-1.278 6.82 6.82 0 0 0 .6-.248 1.831 1.831 0 0 1 1.733.074l1.275.776c.098.06.186.036.228 0 .348-.301.675-.628.976-.976.036-.042.06-.131 0-.228l-.776-1.275a1.834 1.834 0 0 1-.075-1.733c.093-.196.176-.396.25-.6a1.831 1.831 0 0 1 1.278-1.173l1.45-.351c.11-.027.156-.107.16-.162a9.63 9.63 0 0 0 0-1.38c-.004-.055-.05-.135-.161-.161l-1.45-.353c-.626-.152-1.08-.625-1.278-1.172a6.576 6.576 0 0 0-.248-.6 1.833 1.833 0 0 1 .074-1.734l.776-1.274c.06-.098.036-.186 0-.228a9.774 9.774 0 0 0-.976-.976c-.042-.036-.131-.06-.228 0l-1.275.776a1.831 1.831 0 0 1-1.733.074 6.88 6.88 0 0 0-.6-.249 1.835 1.835 0 0 1-1.173-1.278l-.351-1.45c-.027-.11-.107-.156-.162-.16a9.63 9.63 0 0 0-1.38 0Z"/></g></g></svg></span>
198-
</h2>
199-
</doc-anchor-target>
200-
<p>Check out the following <a href="https://retype.com/configuration/project/">Project</a> settings to customize your website.</p>
201-
<doc-anchor-target id="set-the-project-name">
202-
<h3>
203-
<doc-anchor-trigger class="header-anchor-trigger" to="#set-the-project-name">#</doc-anchor-trigger>
204-
<span>Set the project name</span>
205-
</h3>
206-
</doc-anchor-target>
207-
<p>Customize your <strong>Project Name</strong> by setting the <a href="https://retype.com/configuration/project#title"><code v-pre>title</code></a> in your <code v-pre>retype.yml</code> file:</p>
208-
<div class="codeblock-wrapper"><doc-codeblock>
209-
<pre class="language-yaml"><code v-pre class="language-yaml">branding:
210-
title: Your Name Here</code></pre>
211-
</doc-codeblock></div>
212-
<p>Or, use your <a href="https://retype.com/configuration/project/#logo"><code v-pre>logo</code></a>:</p>
213-
<div class="codeblock-wrapper"><doc-codeblock>
214-
<pre class="language-yaml"><code v-pre class="language-yaml">branding:
215-
logo: static/your-logo.png</code></pre>
216-
</doc-codeblock></div>
217-
<p>Create a <code v-pre>/static</code> folder and then add a copy of <code v-pre>your-logo.png</code> file to that new folder. You can name the folder and file whatever you want, such as <code v-pre>/images/my-logo.png</code>.</p>
218-
<doc-anchor-target id="set-the-url">
219-
<h3>
220-
<doc-anchor-trigger class="header-anchor-trigger" to="#set-the-url">#</doc-anchor-trigger>
221-
<span>Set the URL</span>
222-
</h3>
223-
</doc-anchor-target>
224-
<p>Improve your website Search Engine Optimization (SEO) by setting the <a href="https://retype.com/configuration/project#url"><code v-pre>url</code></a> in your <code v-pre>retype.yml</code> file:</p>
225-
<div class="codeblock-wrapper"><doc-codeblock>
226-
<pre class="language-yaml"><code v-pre class="language-yaml">url: docs.example.com # Use your website address here</code></pre>
227-
</doc-codeblock></div>
228-
<doc-anchor-target id="add-top-links">
229-
<h3>
230-
<doc-anchor-trigger class="header-anchor-trigger" to="#add-top-links">#</doc-anchor-trigger>
231-
<span>Add top links</span>
232-
</h3>
233-
</doc-anchor-target>
234-
<p>Add custom <a href="https://retype.com/configuration/project/#links"><code v-pre>links</code></a> to the top navigation:</p>
235-
<div class="codeblock-wrapper"><doc-codeblock>
236-
<pre class="language-yaml"><code v-pre class="language-yaml">links:
237-
- text: Visit example.com
238-
icon: globe
239-
link: https://example.com</code></pre>
240-
</doc-codeblock></div>
241-
<doc-anchor-target id="help">
242-
<h2>
243-
<doc-anchor-trigger class="header-anchor-trigger" to="#help">#</doc-anchor-trigger>
244-
<span>Help <svg xmlns="http://www.w3.org/2000/svg" class="docs-icon" viewBox="0 0 24 24" role="presentation"><g fill="currentColor"><g><path d="M10.97 8.265a1.45 1.45 0 0 0-.487.57.75.75 0 0 1-1.341-.67c.2-.402.513-.826.997-1.148C10.627 6.69 11.244 6.5 12 6.5c.658 0 1.369.195 1.934.619a2.45 2.45 0 0 1 1.004 2.006c0 1.033-.513 1.72-1.027 2.215-.19.183-.399.358-.579.508l-.147.123a4.329 4.329 0 0 0-.435.409v1.37a.75.75 0 1 1-1.5 0v-1.473c0-.237.067-.504.247-.736.22-.28.486-.517.718-.714l.183-.153.001-.001c.172-.143.324-.27.47-.412.368-.355.569-.676.569-1.136a.953.953 0 0 0-.404-.806C12.766 8.118 12.384 8 12 8c-.494 0-.814.121-1.03.265ZM13 17a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"/><path d="M12 1c6.075 0 11 4.925 11 11s-4.925 11-11 11S1 18.075 1 12 5.925 1 12 1ZM2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5 9.5 9.5 0 0 0 2.5 12Z"/></g></g></svg></span>
245-
</h2>
246-
</doc-anchor-target>
247-
<p>Need some help with Retype?</p>
248-
<p>A live support person is generally available on <svg xmlns="http://www.w3.org/2000/svg" class="docs-icon" viewBox="0 0 24 24" role="presentation"><g fill="currentColor"><g><path d="M1.5 4.25c0-.966.784-1.75 1.75-1.75h17.5c.966 0 1.75.784 1.75 1.75v12.5a1.75 1.75 0 0 1-1.75 1.75h-9.69l-3.573 3.573A1.458 1.458 0 0 1 5 21.043V18.5H3.25a1.75 1.75 0 0 1-1.75-1.75ZM3.25 4a.25.25 0 0 0-.25.25v12.5c0 .138.112.25.25.25h2.5a.75.75 0 0 1 .75.75v3.19l3.72-3.72a.749.749 0 0 1 .53-.22h10a.25.25 0 0 0 .25-.25V4.25a.25.25 0 0 0-.25-.25Z"/></g></g></svg> chat on the <a href="https://retype.com/">retype.com</a> website.</p>
249-
<p>If you find a defect or would like to submit a feature request, please create an <a href="https://github.com/retypeapp/retype/issues">Issue</a> and we will investigate right away.</p>
250-
<p>Do you have a general inquiry? Please feel free to contact us at <a href="mailto:hello@retype.com">hello@retype.com</a>.</p>
251-
<p>We <span class="docs-emoji">&#x2764;&#xFE0F;</span> your feedback.</p>
178+
<p>This is a page with a top feature image as the header.</p>
252179

253180

254181
<!-- Required only on API pages -->
@@ -297,6 +224,6 @@ <h2>
297224

298225
<div id="docs-overlay-target"></div>
299226

300-
<script data-cfasync="false">window.__DOCS__ = { "title": "Welcome", isRoot: true, level: 0, icon: "file", hasPrism: true, hasMermaid: false, hasMath: false, tocDepth: 23 }</script>
227+
<script data-cfasync="false">window.__DOCS__ = { "title": "Page with header", isRoot: true, level: 0, icon: "file", hasPrism: false, hasMermaid: false, hasMath: false, tocDepth: 23 }</script>
301228
</body>
302229
</html>

0 commit comments

Comments
 (0)