用于动态页面重定向的mkdocs插件可防止链接断开。
mkdocs-redirects的Python项目详细描述
mkdocs重定向
用于^{
安装
Note: This package requires MkDocs version 1.0.4 or higher.
使用pip安装:
pip install mkdocs-redirects
使用
若要使用此插件,请在mkdocs.yml
插件的redirect_maps
设置中指定所需的重定向:
plugins:-redirects:redirect_maps:'old.md':'new.md''old/file.md':'new/file.md''some_file.md':'http://external.url.com/foobar'
注意:不要忘记,如果尚未设置plugins
设置,则指定该设置将覆盖默认设置!有关详细信息,请参见this page。
重定向映射应采用键/值对的形式:
- 每个重定向的关键是原始的markdown doc(相对于
docs_dir
路径)。- 此插件将在
mkdocs build
过程中处理文件名解析。 这应该被设置为原始标记DOC的文件名是什么(或者它^ {EM1}$将是eEM>如果它存在),而不是由MkDocs 渲染的最终HTML文件。
- 此插件将在
- 值是重定向目标。这可以采取以下形式:
- 要重定向到的markdown doc的路径(相对于
docs_dir
)- 此插件将在
mkdocs build
过程中处理文件名解析。 这应该设置为标记文档的文件名,而不是mkdocs呈现的最终html文件
- 此插件将在
- 外部URL(例如
http://example.com
)
- 要重定向到的markdown doc的路径(相对于
在mkdocs build
过程中,此插件将在site_dir
中为每个重定向到“new”路径的“old”文件创建.html
文件。
如果遇到任何问题或重定向目标实际上不存在(如果您有^ {CD13}}),它将产生警告。
use_directory_urls
如果设置了use_directory_urls: true
(这是默认设置),此插件将修改重定向目标到目录url,而不是实际的index.html
文件名。
但是,它将在正确的位置为每个目标创建index.html
文件,以便url解析工作。
例如,'old/dir/README.md': 'new/dir/README.md'
的重定向映射将导致在$site_dir/old/dir/index.html
创建一个html文件,该文件重定向到`/new/dir/。
此外,重定向映射'old/dir/doc_name.md': 'new/dir/doc_name.md'
将导致$site_dir/old/dir/doc_name/index.html
重定向到/new/dir/doc_name/
这个mimcs是mkdocs在没有这个插件的情况下构建site dir的行为。
贡献
- 欢迎拉取请求。
- 在Github Issues tracker中提交错误和建议。
释放
make release
它将提示您输入pypi用户和密码。
请参见:
- https://packaging.python.org/tutorials/packaging-projects/
- https://packaging.python.org/guides/migrating-to-pypi-org/