You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<h3class="anchored" data-anchor-id="rendering-the-documentation">Rendering the documentation</h3>
260
263
<p>The README and documentation website are rendered with <ahref="https://quarto.org/docs/">Quarto</a>. If you make changes to the <code>.qmd</code> files in the root folder and the <code>docs</code> folder, you will need to re-render the docs with Quarto.</p>
261
264
<p>Quarto expects environment variables to be set in a file called <code>_environment</code>, so before running Quarto render commands, you should copy your <code>.env</code> file to <code>_environment</code>.</p>
262
-
<divclass="sourceCode" id="cb1"><preclass="sourceCode bash code-with-copy"><codeclass="sourceCode bash"><spanid="cb1-1"><ahref="#cb1-1" aria-hidden="true" tabindex="-1"></a><spanclass="co"># To copy the .env file to _environment</span></span>
265
+
<divclass="code-copy-outer-scaffold"><divclass="sourceCode" id="cb1"><preclass="sourceCode bash code-with-copy"><codeclass="sourceCode bash"><spanid="cb1-1"><ahref="#cb1-1" aria-hidden="true" tabindex="-1"></a><spanclass="co"># To copy the .env file to _environment</span></span>
<spanid="cb1-3"><ahref="#cb1-3" aria-hidden="true" tabindex="-1"></a><spanclass="co"># To render the documentation website</span></span>
265
268
<spanid="cb1-4"><ahref="#cb1-4" aria-hidden="true" tabindex="-1"></a><spanclass="ex">uv</span> run quarto render</span>
266
269
<spanid="cb1-5"><ahref="#cb1-5" aria-hidden="true" tabindex="-1"></a><spanclass="co"># To render the README</span></span>
267
-
<spanid="cb1-6"><ahref="#cb1-6" aria-hidden="true" tabindex="-1"></a><spanclass="ex">uv</span> run quarto render index.qmd <spanclass="at">--output-dir</span> . <spanclass="at">--output</span> README.md <spanclass="at">--to</span> gfm</span></code><buttontitle="Copy to Clipboard" class="code-copy-button"><iclass="bi"></i></button></pre></div>
270
+
<spanid="cb1-6"><ahref="#cb1-6" aria-hidden="true" tabindex="-1"></a><spanclass="ex">uv</span> run quarto render index.qmd <spanclass="at">--output-dir</span> . <spanclass="at">--output</span> README.md <spanclass="at">--to</span> gfm</span></code></pre></div><buttontitle="Copy to Clipboard" class="code-copy-button"><iclass="bi"></i></button></div>
268
271
<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>
269
272
<p>Note that even if your pull request is merged, your changes will not be reflected on the live website until a maintainer republishes the docs.</p>
<h3class="anchored" data-anchor-id="publishing-the-documentation">Publishing the documentation</h3>
288
291
<p>To publish the documentation to GitHub Pages, run the following command:</p>
289
-
<divclass="sourceCode" id="cb2"><preclass="sourceCode bash code-with-copy"><codeclass="sourceCode bash"><spanid="cb2-1"><ahref="#cb2-1" aria-hidden="true" tabindex="-1"></a><spanclass="ex">uv</span> run quarto publish gh-pages</span></code><buttontitle="Copy to Clipboard" class="code-copy-button"><iclass="bi"></i></button></pre></div>
292
+
<divclass="code-copy-outer-scaffold"><divclass="sourceCode" id="cb2"><preclass="sourceCode bash code-with-copy"><codeclass="sourceCode bash"><spanid="cb2-1"><ahref="#cb2-1" aria-hidden="true" tabindex="-1"></a><spanclass="ex">uv</span> run quarto publish gh-pages</span></code></pre></div><buttontitle="Copy to Clipboard" class="code-copy-button"><iclass="bi"></i></button></div>
0 commit comments