Skip to content

Commit d86fd61

Browse files
Built site for gh-pages
1 parent 124befd commit d86fd61

File tree

8 files changed

+12
-22
lines changed

8 files changed

+12
-22
lines changed

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
be2e2063
1+
1c863cf9

docs/contributing.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,12 @@ <h2 class="anchored" data-anchor-id="contributors">Contributors</h2>
205205
<p>Fork the repository, create a new branch, make your changes, and submit a pull request.</p>
206206
<section id="render-the-documentation" class="level3">
207207
<h3 class="anchored" data-anchor-id="render-the-documentation">Render the documentation</h3>
208-
<p>The documentation is rendered with <a href="https://quarto.org/docs/">Quarto</a>. Make changes to the <code>.qmd</code> files in the <code>docs</code> folder. Then run the following command to render:</p>
209-
<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">quarto</span> render</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
208+
<p>The README and documentation website are rendered with <a href="https://quarto.org/docs/">Quarto</a>. Make changes to the <code>.qmd</code> files in the root folder and the <code>docs</code> folder. Then run the following commands to render:</p>
209+
<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># To render the documentation website</span></span>
210+
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="ex">quarto</span> render</span>
211+
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="co"># To render the README</span></span>
212+
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="ex">quarto</span> render index.qmd <span class="at">--output-dir</span> . <span class="at">--output</span> README.md <span class="at">--to</span> gfm</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
213+
<p>Due to a quirk of Quarto, an unnecessary <code>index.html</code> file is created in the root folder when the README is rendered. This file can be safely deleted.</p>
210214
</section>
211215
</section>
212216
<section id="maintainers" class="level2">

docs/index.html

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/static/Screenshot.png

114 KB
Loading

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ <h1 class="title">FastAPI, Jinja2, PostgreSQL Webapp Template</h1>
209209

210210
<div class="quarto-figure quarto-figure-center">
211211
<figure class="figure">
212-
<p><img src="static/Screenshot.png" class="img-fluid figure-img"></p>
212+
<p><img src="docs/static/Screenshot.png" class="img-fluid figure-img"></p>
213213
<figcaption>Screenshot of homepage</figcaption>
214214
</figure>
215215
</div>

search.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@
4646
"href": "docs/contributing.html",
4747
"title": "Contributing",
4848
"section": "",
49-
"text": "Fork the repository, create a new branch, make your changes, and submit a pull request.\n\n\nThe documentation is rendered with Quarto. Make changes to the .qmd files in the docs folder. Then run the following command to render:\nquarto render"
49+
"text": "Fork the repository, create a new branch, make your changes, and submit a pull request.\n\n\nThe README and documentation website are rendered with Quarto. Make changes to the .qmd files in the root folder and the docs folder. Then run the following commands to render:\n# To render the documentation website\nquarto render\n# To render the README\nquarto render index.qmd --output-dir . --output README.md --to gfm\nDue to a quirk of Quarto, an unnecessary index.html file is created in the root folder when the README is rendered. This file can be safely deleted."
5050
},
5151
{
5252
"objectID": "docs/contributing.html#contributors",
5353
"href": "docs/contributing.html#contributors",
5454
"title": "Contributing",
5555
"section": "",
56-
"text": "Fork the repository, create a new branch, make your changes, and submit a pull request.\n\n\nThe documentation is rendered with Quarto. Make changes to the .qmd files in the docs folder. Then run the following command to render:\nquarto render"
56+
"text": "Fork the repository, create a new branch, make your changes, and submit a pull request.\n\n\nThe README and documentation website are rendered with Quarto. Make changes to the .qmd files in the root folder and the docs folder. Then run the following commands to render:\n# To render the documentation website\nquarto render\n# To render the README\nquarto render index.qmd --output-dir . --output README.md --to gfm\nDue to a quirk of Quarto, an unnecessary index.html file is created in the root folder when the README is rendered. This file can be safely deleted."
5757
},
5858
{
5959
"objectID": "docs/contributing.html#maintainers",

sitemap.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://Promptly-Technologies-LLC.github.io/fastapi-jinja2-postgres-webapp/index.html</loc>
5-
<lastmod>2024-11-19T21:01:46.328Z</lastmod>
5+
<lastmod>2024-11-19T21:27:30.449Z</lastmod>
66
</url>
77
<url>
88
<loc>https://Promptly-Technologies-LLC.github.io/fastapi-jinja2-postgres-webapp/docs/deployment.html</loc>
99
<lastmod>2024-11-19T16:55:55.579Z</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://Promptly-Technologies-LLC.github.io/fastapi-jinja2-postgres-webapp/docs/contributing.html</loc>
13-
<lastmod>2024-11-19T16:55:55.544Z</lastmod>
13+
<lastmod>2024-11-19T21:26:21.179Z</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://Promptly-Technologies-LLC.github.io/fastapi-jinja2-postgres-webapp/docs/architecture.html</loc>

static/Screenshot.png

114 KB
Loading

0 commit comments

Comments
 (0)