centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 7210ff7e2 with MkDocs version: 1.2.3

Browse Source
This commit is contained in:
Oleh Prypin
2021-11-06 08:54:00 +01:00
parent c6173e13a6
commit 411f5600b4
7 changed files with 41 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
about/release-notes/index.html
View File

@@ -345,6 +345,8 @@ mkdocs, version 1.0 from /path/to/mkdocs (Python 3.6)
<li><a href="https://github.com/tomchristie/">@tomchristie</a></li>
<li><a href="https://github.com/d0ugal/">@d0ugal</a></li>
<li><a href="https://github.com/waylan/">@waylan</a></li>
<li><a href="https://github.com/oprypin/">@oprypin</a></li>
<li><a href="https://github.com/ultrabug/">@ultrabug</a></li>
</ul>
<h2 id="version-123-2021-10-12">Version 1.2.3 (2021-10-12)<a class="headerlink" href="#version-123-2021-10-12" title="Permanent link"></a></h2>
<ul>
@@ -358,20 +360,16 @@ mkdocs, version 1.0 from /path/to/mkdocs (Python 3.6)
</ul>
</li>
<li>
<p>Third-party plugins will take precedence over built-in plugins with the same
name (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2591" title="GitHub Issue mkdocs/mkdocs #2591">#2591</a>)</p>
<p>Third-party plugins will take precedence over built-in plugins with the same name (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2591" title="GitHub Issue mkdocs/mkdocs #2591">#2591</a>)</p>
</li>
<li>
<p>Bugfix: Fix ability to load translations for some languages:
core support (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2565" title="GitHub Issue mkdocs/mkdocs #2565">#2565</a>) and search plugin support with fallbacks (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2602" title="GitHub Issue mkdocs/mkdocs #2602">#2602</a>)</p>
<p>Bugfix: Fix ability to load translations for some languages: core support (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2565" title="GitHub Issue mkdocs/mkdocs #2565">#2565</a>) and search plugin support with fallbacks (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2602" title="GitHub Issue mkdocs/mkdocs #2602">#2602</a>)</p>
</li>
<li>
<p>Bugfix (regression in 1.2): Prevent directory traversal in the dev server
(<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2604" title="GitHub Issue mkdocs/mkdocs #2604">#2604</a>)</p>
<p>Bugfix (regression in 1.2): Prevent directory traversal in the dev server (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2604" title="GitHub Issue mkdocs/mkdocs #2604">#2604</a>)</p>
</li>
<li>
<p>Bugfix (regression in 1.2): Prevent webserver warnings from being treated as
a build failure in strict mode (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2607" title="GitHub Issue mkdocs/mkdocs #2607">#2607</a>)</p>
<p>Bugfix (regression in 1.2): Prevent webserver warnings from being treated as a build failure in strict mode (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2607" title="GitHub Issue mkdocs/mkdocs #2607">#2607</a>)</p>
</li>
<li>
<p>Bugfix: Correctly print colorful messages in the terminal on Windows (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2606" title="GitHub Issue mkdocs/mkdocs #2606">#2606</a>)</p>
@@ -380,31 +378,23 @@ mkdocs, version 1.0 from /path/to/mkdocs (Python 3.6)
<p>Bugfix: Python version 3.10 was displayed incorrectly in <code>--version</code> (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2618" title="GitHub Issue mkdocs/mkdocs #2618">#2618</a>)</p>
</li>
</ul>
<p>Other small improvements; see
<a href="https://github.com/mkdocs/mkdocs/compare/1.2.2...1.2.3">commit log</a>.</p>
<p>Other small improvements; see <a href="https://github.com/mkdocs/mkdocs/compare/1.2.2...1.2.3">commit log</a>.</p>
<h2 id="version-122-2021-07-18">Version 1.2.2 (2021-07-18)<a class="headerlink" href="#version-122-2021-07-18" title="Permanent link"></a></h2>
<ul>
<li>
<p>Bugfix (regression in 1.2): Fix serving files/paths with Unicode characters
(<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2464" title="GitHub Issue mkdocs/mkdocs #2464">#2464</a>)</p>
<p>Bugfix (regression in 1.2): Fix serving files/paths with Unicode characters (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2464" title="GitHub Issue mkdocs/mkdocs #2464">#2464</a>)</p>
</li>
<li>
<p>Bugfix (regression in 1.2): Revert livereload file watching to use polling
observer (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2477" title="GitHub Issue mkdocs/mkdocs #2477">#2477</a>)</p>
<p>This had to be done to reasonably support usages that span virtual
filesystems such as non-native Docker and network mounts.</p>
<p>This goes back to the polling approach, very similar to that was always used
prior, meaning most of the same downsides with latency and CPU usage.</p>
<p>Bugfix (regression in 1.2): Revert livereload file watching to use polling observer (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2477" title="GitHub Issue mkdocs/mkdocs #2477">#2477</a>)</p>
<p>This had to be done to reasonably support usages that span virtual filesystems such as non-native Docker and network mounts.</p>
<p>This goes back to the polling approach, very similar to that was always used prior, meaning most of the same downsides with latency and CPU usage.</p>
</li>
<li>
<p>Revert from 1.2: Remove the requirement of a <code>site_url</code> config and the
restriction on <code>use_directory_urls</code> (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2490" title="GitHub Issue mkdocs/mkdocs #2490">#2490</a>)</p>
<p>Revert from 1.2: Remove the requirement of a <code>site_url</code> config and the restriction on <code>use_directory_urls</code> (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2490" title="GitHub Issue mkdocs/mkdocs #2490">#2490</a>)</p>
</li>
<li>
<p>Bugfix (regression in 1.2): Don't require trailing slash in the URL when
serving a directory index in <code>mkdocs serve</code> server (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2507" title="GitHub Issue mkdocs/mkdocs #2507">#2507</a>)</p>
<p>Instead of showing a 404 error, detect if it's a directory and redirect to a
path with a trailing slash added, like before.</p>
<p>Bugfix (regression in 1.2): Don't require trailing slash in the URL when serving a directory index in <code>mkdocs serve</code> server (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2507" title="GitHub Issue mkdocs/mkdocs #2507">#2507</a>)</p>
<p>Instead of showing a 404 error, detect if it's a directory and redirect to a path with a trailing slash added, like before.</p>
</li>
<li>
<p>Bugfix: Fix <code>gh_deploy</code> with config-file in the current directory (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2481" title="GitHub Issue mkdocs/mkdocs #2481">#2481</a>)</p>
@@ -419,8 +409,7 @@ path with a trailing slash added, like before.</p>
<p>Stop treating ";" as a special character in URLs: urlparse -&gt; urlsplit (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2502" title="GitHub Issue mkdocs/mkdocs #2502">#2502</a>)</p>
</li>
<li>
<p>Improve build performance for sites with many pages (partly already done in
1.2) (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2407" title="GitHub Issue mkdocs/mkdocs #2407">#2407</a>)</p>
<p>Improve build performance for sites with many pages (partly already done in 1.2) (<a class="gh-link gh-issue" href="https://github.com/mkdocs/mkdocs/issues/2407" title="GitHub Issue mkdocs/mkdocs #2407">#2407</a>)</p>
</li>
</ul>
<h2 id="version-121-2021-06-09">Version 1.2.1 (2021-06-09)<a class="headerlink" href="#version-121-2021-06-09" title="Permanent link"></a></h2>
@@ -539,7 +528,7 @@ string. In that case, if <code>use_directory_urls</code> is not explicitly set t
</li>
<li>
<p>The <code>google_analytics</code> configuration option is deprecated as Google appears to
be fazing it out in favor of its new Google Analytics 4 property. See the
be phasing it out in favor of its new Google Analytics 4 property. See the
documentation for your theme for alternatives which can be configured as part
of your theme configuration. For example, the <a href="../../user-guide/choosing-your-theme/#mkdocs">mkdocs</a> and
<a href="../../user-guide/choosing-your-theme/#readthedocs">readthedocs</a> themes have each added a new <code>theme.analytics.gtag</code>

4
dev-guide/themes/index.html
View File

@@ -708,12 +708,12 @@ your theme, your users can more easily install it, they can rely on a default
<p>The following layout is recommended for themes. Two files at the top level
directory called <code>MANIFEST.in</code> and <code>setup.py</code> beside the theme directory which
contains an empty <code>__init__.py</code> file, a theme configuration file
(<code>mkdocs-theme.yml</code>), and your template and media files.</p>
(<code>mkdocs_theme.yml</code>), and your template and media files.</p>
<pre><code class="language-no-highlight">.
|-- MANIFEST.in
|-- theme_name
| |-- __init__.py
| |-- mkdocs-theme.yml
| |-- mkdocs_theme.yml
| |-- main.html
| |-- styles.css
`-- setup.py

2
index.html
View File

@@ -337,5 +337,5 @@ configuration file. Start by reading the <a href="getting-started/">introductory
<!--
MkDocs version : 1.2.3
Build Date UTC : 2021-10-12 21:56:23.699016+00:00
Build Date UTC : 2021-11-06 07:54:00.534584+00:00
-->

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

34
sitemap.xml
View File

@@ -2,87 +2,87 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://www.mkdocs.org/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/getting-started/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/about/contributing/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/about/license/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/about/release-notes/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/dev-guide/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/dev-guide/plugins/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/dev-guide/themes/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/dev-guide/translations/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/choosing-your-theme/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/configuration/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/customizing-your-theme/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/deploying-your-docs/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/installation/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/localizing-your-theme/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://www.mkdocs.org/user-guide/writing-your-docs/</loc>
<lastmod>2021-10-12</lastmod>
<lastmod>2021-11-06</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.

7
user-guide/configuration/index.html
View File

@@ -321,9 +321,10 @@ for the site. A minimal navigation configuration could look like this:</p>
- 'index.md'
- 'about.md'
</code></pre>
<p>All paths must be relative to the <code>mkdocs.yml</code> configuration file. See the
section on <a href="../writing-your-docs/#configure-pages-and-navigation">configuring pages and navigation</a> for a more detailed breakdown,
including how to create sub-sections.</p>
<p>All paths in the navigation configuration must be relative to the
<a href="#docs_dir"><code>docs_dir</code></a> configuration option. See the section on <a href="../writing-your-docs/#configure-pages-and-navigation">configuring
pages and navigation</a> for a more detailed breakdown, including how to create
sub-sections.</p>
<p>Navigation items may also include links to external sites. While titles are
optional for internal links, they are required for external links. An external
link may be a full URL or a relative URL. Any path which is not found in the