Deployed e80e153 with MkDocs version: 1.5.3

jodygarnett · Feb 22, 2024 · 822df2c · 822df2c
1 parent 7df4a29
commit 822df2c
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 26 deletions.
diff --git a/guide/index.html b/guide/index.html
@@ -522,10 +522,12 @@
 
 <h1 id="writing-guide">Writing Guide</h1>
 <p>Working with documentation, markdown formatting, and writing style guide.</p>
+<div class="grid cards">
 <ul>
 <li><a href="markdown/">Markdown</a></li>
 <li><a href="style/">Style Guide</a></li>
 </ul>
+</div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The <strong><em>mkdoc_translate</em></strong> script can adapt some markdown extensions for use with <strong><em>pandoc</em></strong> conversion, but not everything.</p>

diff --git a/index.html b/index.html
@@ -471,12 +471,14 @@
 
 <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>
+<div class="grid cards">
 <ul>
 <li><a href="setup/">Getting started</a></li>
 <li><a href="translate/">Translate Script</a></li>
 <li><a href="guide/">Writing Guide</a></li>
 <li><a href="development/">Development</a></li>
 </ul>
+</div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This is an example project, see project <a href="https://github.com/jodygarnett/translate/blob/main/README.md">README.md</a> for most recent instructions.</p>

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/setup/download/mkdocs.yml b/setup/download/mkdocs.yml
@@ -126,8 +126,8 @@ nav:
 - setup/index.md
 - Translate:
   - translate/index.md
-  - translate/migrate.md
-  - translate/language.md
+  - Migrate: translate/migrate.md
+  - Language: translate/language.md
 - Guide:
   - guide/index.md
   - guide/markdown.md

diff --git a/setup/download/translate.yml b/setup/download/translate.yml
@@ -18,6 +18,11 @@ extlinks:
   squidfunk: https://squidfunk.github.io/mkdocs-material/%s
 macro_ignore:
   - setup/index.md
+nav:
+  index.md: Home
+  'translate/index.md': Translate
+  'translate/migrate.md': Migrate
+  guide/index.md: Guide
 
 # markdown internationalization
 deepl_base_url: "https://api-free.deepl.com"

diff --git a/setup/index.html b/setup/index.html
@@ -871,11 +871,16 @@ <h2 id="config">Configuration</h2>
 </span><span id="__span-10-18"><a id="__codelineno-10-18" name="__codelineno-10-18" href="#__codelineno-10-18"></a><span class="w">  </span><span class="nt">squidfunk</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://squidfunk.github.io/mkdocs-material/%s</span>
 </span><span id="__span-10-19"><a id="__codelineno-10-19" name="__codelineno-10-19" href="#__codelineno-10-19"></a><span class="nt">macro_ignore</span><span class="p">:</span>
 </span><span id="__span-10-20"><a id="__codelineno-10-20" name="__codelineno-10-20" href="#__codelineno-10-20"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">setup/index.md</span>
-</span><span id="__span-10-21"><a id="__codelineno-10-21" name="__codelineno-10-21" href="#__codelineno-10-21"></a>
-</span><span id="__span-10-22"><a id="__codelineno-10-22" name="__codelineno-10-22" href="#__codelineno-10-22"></a><span class="c1"># markdown internationalization</span>
-</span><span id="__span-10-23"><a id="__codelineno-10-23" name="__codelineno-10-23" href="#__codelineno-10-23"></a><span class="nt">deepl_base_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://api-free.deepl.com&quot;</span>
-</span><span id="__span-10-24"><a id="__codelineno-10-24" name="__codelineno-10-24" href="#__codelineno-10-24"></a><span class="nt">upload_folder</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;upload&quot;</span>
-</span><span id="__span-10-25"><a id="__codelineno-10-25" name="__codelineno-10-25" href="#__codelineno-10-25"></a><span class="nt">download_folder</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;download&quot;</span>
+</span><span id="__span-10-21"><a id="__codelineno-10-21" name="__codelineno-10-21" href="#__codelineno-10-21"></a><span class="nt">nav</span><span class="p">:</span>
+</span><span id="__span-10-22"><a id="__codelineno-10-22" name="__codelineno-10-22" href="#__codelineno-10-22"></a><span class="w">  </span><span class="nt">index.md</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Home</span>
+</span><span id="__span-10-23"><a id="__codelineno-10-23" name="__codelineno-10-23" href="#__codelineno-10-23"></a><span class="w">  </span><span class="s">&#39;translate/index.md&#39;</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Translate</span>
+</span><span id="__span-10-24"><a id="__codelineno-10-24" name="__codelineno-10-24" href="#__codelineno-10-24"></a><span class="w">  </span><span class="s">&#39;translate/migrate.md&#39;</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Migrate</span>
+</span><span id="__span-10-25"><a id="__codelineno-10-25" name="__codelineno-10-25" href="#__codelineno-10-25"></a><span class="w">  </span><span class="nt">guide/index.md</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Guide</span>
+</span><span id="__span-10-26"><a id="__codelineno-10-26" name="__codelineno-10-26" href="#__codelineno-10-26"></a>
+</span><span id="__span-10-27"><a id="__codelineno-10-27" name="__codelineno-10-27" href="#__codelineno-10-27"></a><span class="c1"># markdown internationalization</span>
+</span><span id="__span-10-28"><a id="__codelineno-10-28" name="__codelineno-10-28" href="#__codelineno-10-28"></a><span class="nt">deepl_base_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://api-free.deepl.com&quot;</span>
+</span><span id="__span-10-29"><a id="__codelineno-10-29" name="__codelineno-10-29" href="#__codelineno-10-29"></a><span class="nt">upload_folder</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;upload&quot;</span>
+</span><span id="__span-10-30"><a id="__codelineno-10-30" name="__codelineno-10-30" href="#__codelineno-10-30"></a><span class="nt">download_folder</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;download&quot;</span>
 </span></code></pre></div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -993,6 +998,10 @@ <h2 id="config">Configuration</h2>
 <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>
+<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>
 </dl>
 
 

diff --git a/sitemap.xml b/sitemap.xml
@@ -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-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/development/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/download/LICENSE/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/guide/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/guide/markdown/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/guide/style/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/guide/download/LICENSE/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/setup/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/translate/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/translate/language/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>http://jodygarnett.github.io/translate/translate/migrate/</loc>
-         <lastmod>2024-02-20</lastmod>
+         <lastmod>2024-02-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/translate/index.html b/translate/index.html
@@ -522,10 +522,12 @@
 
 <h1 id="translate-script">Translate Script</h1>
 <p>The translate script is used for migrating contents to mkdocs, and translating mkdocs content between languages.</p>
+<div class="grid cards">
 <ul>
-<li><a href="migrate/">Migrate</a></li>
+<li><a href="migrate/">Migrate to MkDocs</a></li>
 <li><a href="language/">Language</a></li>
 </ul>
+</div>
 
 
 

diff --git a/translate/language/index.html b/translate/language/index.html
@@ -78,7 +78,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#language" class="md-skip">
+        <a href="#language-internationalization" class="md-skip">
           Skip to content
         </a>
 
@@ -634,7 +634,7 @@
 
 
 
-<h1 id="language">Language</h1>
+<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>

diff --git a/translate/migrate/index.html b/translate/migrate/index.html
@@ -78,7 +78,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#migrate_1" class="md-skip">
+        <a href="#migrate-from-sphinx-build-to-mkdocs" class="md-skip">
           Skip to content
         </a>
 
@@ -640,7 +640,7 @@
 
 
 
-<h1 id="migrate_1">Migrate</h1>
+<h1 id="migrate-from-sphinx-build-to-mkdocs">Migrate from sphinx-build to mkdocs</h1>
 <h2 id="preflight">Preflight</h2>
 <ol>
 <li>
@@ -666,12 +666,15 @@ <h2 id="preflight">Preflight</h2>
 <ul>
 <li>
 <p>You can run these scans independently:</p>
-<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>mkdocs_translate<span class="w"> </span>scan<span class="w"> </span>download
+<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>mkdocs_translate<span class="w"> </span>scan<span class="w"> </span>--scan<span class="o">=</span>download
+</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>mkdocs_translate<span class="w"> </span>scan<span class="w"> </span>--scan<span class="o">=</span>index
 </span></code></pre></div>
 </li>
 <li>
 <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>download<span class="w"> </span>--test<span class="w"> </span>source/setup/index.rst
+<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
 </span></code></pre></div>
 </li>
 </ul>