Skip to content

Commit

Permalink
Deployed ced68f5 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
jodygarnett committed Feb 23, 2024
1 parent b4ae540 commit 9d0e59d
Show file tree
Hide file tree
Showing 10 changed files with 67 additions and 62 deletions.
2 changes: 1 addition & 1 deletion development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ <h2 id="pandoc">Pandoc</h2>
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a>diff<span class="w"> </span>docs/contributing/style-guide.md<span class="w"> </span>build/convert/contributing/style-guide.md
</span></code></pre></div>
<p>Langauge conversion uses <code>text/html</code>to avoid internationalization of content distributing markdown formatting.</p>
<p>Langauge conversion uses <code>text/html</code> to avoid internationalization of content distributing markdown formatting.</p>
</li>
</ol>

Expand Down
1 change: 1 addition & 0 deletions guide/files/copy_me
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is an example of a file without an extension used to double check init will copy such a file.
56 changes: 30 additions & 26 deletions guide/markdown/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@


<h1 id="mkdocs-translate">MkDocs Translate</h1>
<p>Translation example for <code>mkdocs_translate</code>script <a href="https://github.com/jodygarnett/translate/releases/tag/0.9">Release 0.9</a>.</p>
<p>Translation example for <code>mkdocs_translate</code> script <a href="https://github.com/jodygarnett/translate/releases/tag/0.9">Release 0.9</a>.</p>
<div class="grid cards">
<ul>
<li><a href="setup/">Getting started</a></li>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions setup/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -782,7 +782,7 @@ <h2 id="setup">Project setup</h2>
</li>
</ol>
<h2 id="download_hook">Download Hook</h2>
<p>Optional: If your content uses <code>download</code>directive to include external content, there is a <code>mkdocs</code>hook for processing of <code>download.txt</code>files.</p>
<p>Optional: If your content uses <code>download</code> directive to include external content, there is a <code>mkdocs</code> hook for processing of <code>download.txt</code> files.</p>
<ol>
<li>
<p>Create <a href="download/download.py">download.py</a>.</p>
Expand Down Expand Up @@ -825,7 +825,7 @@ <h2 id="download_hook">Download Hook</h2>
</span></code></pre></div>
</li>
<li>
<p>Register hook with <code>mkdocs.yml</code></p>
<p>Register hook with <code>mkdocs.yml</code>:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="c1"># Customizations</span>
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="nt">hooks</span><span class="p">:</span>
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">download.py</span>
Expand Down Expand Up @@ -922,55 +922,55 @@ <h2 id="config">Configuration</h2>
<dd>
<p>Default assumes you are running from the current directory.</p>
</dd>
<dt><code>docs_folder</code> <code>docs</code></dt>
<dt><code>docs_folder</code>: <code>docs</code></dt>
<dd>
<p>mkdocs convention.</p>
</dd>
<dt><code>build_folder</code> <code>build</code></dt>
<dt><code>build_folder</code>: <code>build</code></dt>
<dd>
<p>The use of <code>build</code> follows sphinx-build and mkdocs convention, maven projects may wish to use <code>target</code>.</p>
</dd>
<dt><code>rst_folder</code> <code>source</code></dt>
<dt><code>rst_folder</code>: <code>source</code></dt>
<dd>
<p>Location of sphinx-build documentation to migrate to mkdocs.</p>
</dd>
<dt><code>anchor_file</code> <code>anchors.txt</code></dt>
<dt><code>anchor_file</code>: <code>anchors.txt</code></dt>
<dd>
<p>Name of index file used to lookup anchor and title information during migration.</p>
</dd>
<dt><code>convert_folder</code> <code>migrate</code></dt>
<dt><code>convert_folder</code>: <code>migrate</code></dt>
<dd>
<p>Combined with <code>build_folder</code> for rst conversion temporary files (example: <code>build/migrate</code>. Temporary files are required for use by pandoc.</p>
<p>Combined with <code>build_folder</code> for rst conversion temporary files (example: <code>build/migrate</code>). Temporary files are required for use by pandoc.</p>
</dd>
<dt><code>upload_folder</code> <code>upload</code></dt>
<dt><code>upload_folder</code>: <code>upload</code></dt>
<dd>
<p>Combined with <code>build_folder</code> to stage html files for internationalization (example: <code>build/upload</code>)</p>
</dd>
<dt><code>deepl_base_url</code>: <code>https://api-free.deepl.com</code></dt>
<dd>
<p>Customize if you have a subscription to deepl.</p>
</dd>
<dt><code>download_folder</code> <code>download</code></dt>
<dt><code>download_folder</code>: <code>download</code></dt>
<dd>
<p>Combined with <code>build_folder</code> to retrieve internationalization results (example: <code>build/download</code>) Temporary files are required for use by pandoc.</p>
</dd>
<dt><code>substitutions</code></dt>
<dt><code>substitutions</code>:</dt>
<dd>
<p>dictionary of <code>|substitutions|</code>to use when converting config.py rst_epilog common substitutions.</p>
<p>dictionary of <code>|substitutions|</code> to use when converting config.py rst_epilog common substitutions.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="nt">project</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GeoServer</span>
</span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="nt">author</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Open Source Geospatial Foundation</span>
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="nt">copyright</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2023, Open Source Geospatial Foundation</span>
</span><span id="__span-12-4"><a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="nt">project_copyright</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2023, Open Source Geospatial Foundation</span>
</span></code></pre></div>
<p>The built-in substitutions for <code>{{ version }}</code>and <code>{{ release }}</code>are changed to <code>{{ version }}</code> and <code>{{ release }}</code> variables for use with <code>mkdocs-macros-plugin</code>variable substitution:</p>
<p>The built-in substitutions for <code>{{ version }}</code> and <code>{{ release }}</code> are changed to <code>{{ version }}</code> and <code>{{ release }}</code> variables for use with <code>mkdocs-macros-plugin</code> variable substitution:</p>
<p>Use <strong><code>mkdocs.yml</code></strong> to define these variable substitutions:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="nt">extra</span><span class="p">:</span>
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w"> </span><span class="nt">homepage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://geoserver.org/</span>
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;2.24&#39;</span>
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="w"> </span><span class="nt">release</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;2.24.2&#39;</span>
</span></code></pre></div>
</dd>
<dt><code>extlinks</code></dt>
<dt><code>extlinks</code>:</dt>
<dd>
<p>dictionary of config.py extlinks substitutions taking the form:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>extlinks:
Expand All @@ -981,7 +981,7 @@ <h2 id="config">Configuration</h2>
</span></code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Use of <code>mkdocs-macros-plugin</code>for variable substitution of <code>release</code>above.</p>
<p>Use of <code>mkdocs-macros-plugin</code> for variable substitution of <code>release</code> above.</p>
<p>Use of <code>|GEOS-%s</code> to override default link text <code>%s</code>.</p>
</div>
<p>This handles the sphinx-build <strong><code>config.py</code></strong> extlinks during migration:</p>
Expand All @@ -993,12 +993,12 @@ <h2 id="config">Configuration</h2>
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="p">}</span>
</span></code></pre></div>
</dd>
<dt><code>macro_ignore</code></dt>
<dt><code>macro_ignore</code>:</dt>
<dd>
<p>Use of <code>mkdocs-macros-plugin</code>can conflict with code examples.</p>
<p>This script adds the YAML header to enable macros to better support the use <code>{{ version }}</code>and <code>{{ release }}</code> If you find this accidentially is triggered by code examples you can add an ignore.</p>
<p>Use of <code>mkdocs-macros-plugin</code> can conflict with code examples.</p>
<p>This script adds the YAML header to enable macros to better support the use <code>{{ version }}</code> and <code>{{ release }}</code>. If you find this accidentially is triggered by code examples you can add an ignore.</p>
</dd>
<dt><code>nav</code></dt>
<dt><code>nav</code>:</dt>
<dd>
<p>Provide simplified title for navigation, incase <code>toctree</code> title is too long. Most often used to override top-level <strong><code>index.rst</code></strong> title as "Home".</p>
</dd>
Expand Down
22 changes: 11 additions & 11 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,57 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://jodygarnett.github.io/translate/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/development/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/download/LICENSE/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/guide/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/guide/markdown/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/guide/style/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/guide/download/LICENSE/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/setup/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/translate/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/translate/language/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://jodygarnett.github.io/translate/translate/migrate/</loc>
<lastmod>2024-02-22</lastmod>
<lastmod>2024-02-23</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
Binary file not shown.
4 changes: 2 additions & 2 deletions translate/language/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@
<h1 id="language-internationalization">Language Internationalization</h1>
<p>To help manage a multi-language build is it kind to provide human translators with an example document to start from.</p>
<h2 id="setup">Setup</h2>
<p>The <code>mkdocs-static-i18n &lt;https://ultrabug.github.io/mkdocs-static-i18n/&gt;</code>plugin is setup based on suffix, with <strong><code>index.md</code></strong> is the default English, and <strong><code>index.fr.md</code></strong> used for French:</p>
<p>The <code>mkdocs-static-i18n &lt;https://ultrabug.github.io/mkdocs-static-i18n/&gt;</code> plugin is setup based on suffix, with <strong><code>index.md</code></strong> is the default English, and <strong><code>index.fr.md</code></strong> used for French:</p>
<div class="language-text highlight"><pre><span></span><code>| index.md
| index.fr.md
+ img/
Expand All @@ -661,7 +661,7 @@ <h2 id="setup">Setup</h2>
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w"> </span><span class="nt">Search</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Recherche</span>
</span></code></pre></div>
<h2 id="translate">Language Translation</h2>
<p>Translation uses <strong><em>pandoc</em></strong> to convert to <code>html</code> and then using <a href="https://deepl.com">Deepl REST API</a>.</p>
<p>Translation uses <strong><em>pandoc</em></strong> to convert to <code>html</code>, and then using <a href="https://deepl.com">Deepl REST API</a>.</p>
<ol>
<li>
<p>Provide environmental variable with Deepl authentication key:</p>
Expand Down
2 changes: 1 addition & 1 deletion translate/migrate/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ <h2 id="preflight">Preflight</h2>
</span></code></pre></div>
</li>
<li>
<p>To troubleshoot an individual file, the resulting <code>index</code>can be sent to standard out:</p>
<p>To troubleshoot an individual file, the resulting <code>index</code> can be sent to standard out:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>mkdocs_translate<span class="w"> </span>scan<span class="w"> </span>source/setup/index.rst
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>mkdocs_translate<span class="w"> </span>scan<span class="w"> </span>--scan<span class="o">=</span>download<span class="w"> </span>source/setup/index.rst
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>mkdocs_translate<span class="w"> </span>scan<span class="w"> </span>--scan<span class="o">=</span>index<span class="w"> </span>source/setup/index.rst
Expand Down

0 comments on commit 9d0e59d

Please sign in to comment.