{"id":49820,"date":"2023-10-17T14:34:35","date_gmt":"2023-05-11T05:42:56","guid":{"rendered":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/"},"modified":"2024-05-04T04:43:36","modified_gmt":"2024-05-03T20:43:36","slug":"%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/","title":{"rendered":"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9"},"content":{"rendered":"<h1>\u9996\u5148<\/h1>\n<p>\u4f7f\u7528Markdown\u7f16\u5199\u9879\u76ee\u6587\u6863\uff0c\u5e76\u7ed8\u5236\u6d41\u7a0b\u56fe\u548cUML\u56fe\uff0c\u5e76\u5e0c\u671b\u8fdb\u884c\u6258\u7ba1\uff0c\u4f46\u4e0d\u80fd\u4f7f\u7528\u4e91\u670d\u52a1\uff08\u5982github pages\u6216gitlab pages\uff09\uff0c\u4f46\u5374\u5e0c\u671b\u80fd\u591f\u6dfb\u52a0\u8eab\u4efd\u9a8c\u8bc1\uff0c\u8fd9\u5c31\u662f\u6211\u601d\u8003\u4f7f\u7528Django+MkDocs\u6765\u5b9e\u73b0\u8fd9\u4e9b\u529f\u80fd\u7684\u539f\u56e0\u3002\uff08\u662f\u5426\u5b9e\u7528\u5c1a\u4e0d\u6e05\u695a\uff09<\/p>\n<h1>\u5173\u4e8eMkDocs<\/h1>\n<p>MkDocs\u662f\u4e00\u4e2a\u529f\u80fd\u5f3a\u5927\u7684\u9759\u6001\u7f51\u7ad9\u751f\u6210\u7a0b\u5e8f\uff0c\u5141\u8bb8\u7528Markdown\u683c\u5f0f\u7f16\u5199\u9879\u76ee\u6587\u6863\u3002\u5b83\u662f\u7528Python\u5f00\u53d1\u7684\uff0c\u53ef\u4ee5\u901a\u8fc7pip\u8fdb\u884c\u5b89\u88c5\u3002\u8fd8\u63d0\u4f9b\u4e86\u591a\u79cd\u4e3b\u9898\uff0c\u53ef\u4ee5\u5b9e\u73b0\u7c7b\u4f3c\u4e8eReadtheDoc\u7684\u6548\u679c\u3002<\/p>\n<h1>\u524d\u63d0 &#8211; \u63d0\u524d\u7684\u6761\u4ef6\u6216\u5047\u8bbe\uff0c\u7528\u4ee5\u63a8\u65ad\u6216\u8ba8\u8bba\u5176\u4ed6\u4e8b\u60c5\u3002<\/h1>\n<p>\u8fd9\u6b21\u6211\u4eec\u5c06\u4f7f\u7528Django 2\u7cfb\u8fdb\u884c\u642d\u5efa\u3002<\/p>\n<h1>\u5236\u4f5c<\/h1>\n<h3>\u521b\u5efa Django \u9879\u76ee<\/h3>\n<pre class=\"post-pre\"><code><span class=\"gp\">#<\/span> \u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3092\u4f5c\u6210\r\n<span class=\"go\">django-admin startproject django_mkdocs\r\n\r\n<\/span><span class=\"gp\">#<\/span> docs\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u3092\u4f5c\u6210\r\n<span class=\"go\">python manage.py startapp docs\r\n\r\n<\/span><span class=\"gp\">#<\/span> MkDocs\u3092\u30d3\u30eb\u30c9\u3057\u305fHTML\u7b49\u306e\u9759\u7684\u30d5\u30a1\u30a4\u30eb\u3092\u683c\u7d0d\u3059\u308b\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3092\u4f5c\u6210\r\n<span class=\"go\">mkdir docs\/static\r\n<\/span><\/code><\/pre>\n<p>\u5c06\u5df2\u521b\u5efa\u7684docs\u5e94\u7528\u7a0b\u5e8f\u5728setting.py\u4e2d\u8fdb\u884c\u6ce8\u518c\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<span class=\"n\">INSTALLED_APPS<\/span> <span class=\"o\">=<\/span> <span class=\"p\">[<\/span>\r\n    <span class=\"s\">'django.contrib.admin'<\/span><span class=\"p\">,<\/span>\r\n    <span class=\"s\">'django.contrib.auth'<\/span><span class=\"p\">,<\/span>\r\n    <span class=\"s\">'django.contrib.contenttypes'<\/span><span class=\"p\">,<\/span>\r\n    <span class=\"s\">'django.contrib.sessions'<\/span><span class=\"p\">,<\/span>\r\n    <span class=\"s\">'django.contrib.messages'<\/span><span class=\"p\">,<\/span>\r\n    <span class=\"s\">'django.contrib.staticfiles'<\/span><span class=\"p\">,<\/span>\r\n    <span class=\"s\">'docs'<\/span><span class=\"p\">,<\/span>\r\n<span class=\"p\">]<\/span>\r\n<span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<\/code><\/pre>\n<h3>\u5b89\u88c5MkDocs<\/h3>\n<p>\u901a\u8fc7\u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4\uff0c\u60a8\u53ef\u4ee5\u521b\u5efa\u4e00\u4e2a\u65b0\u7684\u9879\u76ee\uff1a\u4f7f\u7528MkDocs\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"gp\">#<\/span> \u4f8b\r\n<span class=\"go\">mkdocs new (\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u540d)\r\n<\/span><\/code><\/pre>\n<p>\u6211\u6253\u7b97\u521b\u5efa\u4e00\u4e2a\u53ebmkdocs\u7684\u9879\u76ee\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"go\">mkdocs new mkdocs\r\n<\/span><\/code><\/pre>\n<p>\u6211\u8ba4\u4e3a\u5728Django\u9879\u76ee\u4e2d\u8f93\u5165\u65f6\uff0c\u4f1a\u751f\u6210\u4ee5\u4e0b\u7c7b\u4f3c\u7684\u6587\u4ef6\u3002<\/p>\n<pre class=\"post-pre\"><code>mkdocs\r\n\u251cdocs\r\n\u2502  \u2514index.md :\u3000\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\r\n\u2514 mkdocs.yml\u3000\u3000:\u3000config\u30d5\u30a1\u30a4\u30eb\r\n<\/code><\/pre>\n<p>\u63a5\u4e0b\u6765\uff0c\u6211\u4eec\u5c06\u542f\u52a8\u6587\u6863\u670d\u52a1\u5668\uff0c\u4ee5\u786e\u8ba4MkDocs\u662f\u5426\u6b63\u5e38\u5de5\u4f5c\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"go\">cd mkdocs\r\nmkdocs serve\r\n\r\n\u30fb\u30fb\u30fb\r\n[I 180929 22:49:17 server:292] Serving on http:\/\/127.0.0.1:8000\r\n[I 180929 22:49:17 handlers:59] Start watching changes\r\n[I 180929 22:49:17 handlers:61] Start detecting changes\r\n[I 180929 22:49:21 handlers:132] Browser Connected: http:\/\/127.0.0.1:8000\/\r\n<\/span><\/code><\/pre>\n<p>\u5e76\u6210\u529f\u5728\u672c\u5730\u8fd0\u884c\u4e86MkDocs\uff0c\u5982\u4e0a\u6240\u793a\u3002<\/p>\n<p>\u7279\u522b\u662f\u5982\u679c\u73b0\u5728\u8fd9\u6837\u6ca1\u95ee\u9898\u7684\u8bdd\uff0c\u7531\u4e8e\u5fc5\u987b\u5728yml\u76f4\u63a5\u4e0b\u9762\u8f93\u5165\u547d\u4ee4\uff0c\u6240\u4ee5\u4f1a\u6539\u53d8yml\u7684\u4f4d\u7f6e\u548c\u6587\u6863\uff08index.md\uff09\u7684\u4f4d\u7f6e\u3002<\/p>\n<pre class=\"post-pre\"><code>mv mkdocs\/mkdocs.yml .\r\nmv mkdocs\/docs\/index.md mkdocs\/\r\nrm -r mkdocs\/docs\r\n<\/code><\/pre>\n<p>\u5982\u679c\u4fdd\u6301\u8fd9\u79cd\u72b6\u6001\uff0cMkDocs\u5c06\u65e0\u6cd5\u8fd0\u884c\uff0c\u56e0\u6b64\u9700\u8981\u4fee\u6539mkdocs.yml\u6587\u4ef6\u3002<\/p>\n<div>\n<div class=\"post-table\">key\u5185\u5bb9site_name\u30b5\u30a4\u30c8\u540dtheme\u30c6\u30fc\u30dedocs_dir\u30de\u30fc\u30af\u30c0\u30a6\u30f3\u30d5\u30a1\u30a4\u30eb\u3092\u683c\u7d0d\u3059\u308b\u30c7\u30a3\u30ec\u30af\u30c8\u30easite_dir\u30d3\u30eb\u30c9\u3055\u308c\u305fHTML\u30d5\u30a1\u30a4\u30eb\u7b49\u3092\u683c\u7d0d\u3059\u308b\u30c7\u30a3\u30ec\u30af\u30c8\u30ea<\/div>\n<\/div>\n<p>\u8fd9\u6b21\u8bbe\u7f6e\u5982\u4e0b\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"na\">site_name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Django + MkDocs Site<\/span>\r\n\r\n<span class=\"na\">docs_dir<\/span><span class=\"pi\">:<\/span> <span class=\"s1\">'<\/span><span class=\"s\">mkdocs'<\/span>\r\n<span class=\"na\">site_dir<\/span><span class=\"pi\">:<\/span> <span class=\"s1\">'<\/span><span class=\"s\">docs\/static\/docs'<\/span>\r\n<\/code><\/pre>\n<p>\u5728\u6b64\u4e4b\u540e\uff0c\u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4\u5c1d\u8bd5\u6784\u5efaMkDocs\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"go\">mkdocs build\r\n<\/span><\/code><\/pre>\n<p>\u53ea\u8981\u5728docs\/static\/docs\u4e0b\u5efa\u7acb\u4e86\u6784\u5efa\u6587\u4ef6\u5c31\u53ef\u4ee5\u4e86\u3002<\/p>\n<p>\u8bf7\u53c2\u8003\u5b98\u65b9\u7f51\u7ad9\u4ee5\u83b7\u53d6MkDocs\u547d\u4ee4\u548cyml\u7684\u76f8\u5173\u4fe1\u606f\u3002<br \/>\nhttps:\/\/www.mkdocs.org<\/p>\n<h2>\u521b\u5efaDocs\u5e94\u7528\u7a0b\u5e8f<\/h2>\n<h3>Django Mkdocs\u7684\u4e2d\u6587\u91ca\u4e49\u4e3a\uff1a<\/h3>\n<pre class=\"post-pre\"><code><span class=\"s\">\"\"\"\r\ndjango_mkdocs\/urls.py\r\n\"\"\"<\/span>\r\n\r\n<span class=\"kn\">from<\/span> <span class=\"nn\">django.contrib<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">admin<\/span>\r\n<span class=\"kn\">from<\/span> <span class=\"nn\">django.urls<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">path<\/span><span class=\"p\">,<\/span> <span class=\"n\">include<\/span>\r\n\r\n<span class=\"n\">urlpatterns<\/span> <span class=\"o\">=<\/span> <span class=\"p\">[<\/span>\r\n    <span class=\"n\">path<\/span><span class=\"p\">(<\/span><span class=\"s\">'admin\/'<\/span><span class=\"p\">,<\/span> <span class=\"n\">admin<\/span><span class=\"p\">.<\/span><span class=\"n\">site<\/span><span class=\"p\">.<\/span><span class=\"n\">urls<\/span><span class=\"p\">),<\/span>\r\n    <span class=\"n\">path<\/span><span class=\"p\">(<\/span><span class=\"s\">'docs\/'<\/span><span class=\"p\">,<\/span> <span class=\"n\">include<\/span><span class=\"p\">(<\/span><span class=\"s\">'docs.urls'<\/span><span class=\"p\">)),<\/span>\r\n<span class=\"p\">]<\/span>\r\n\r\n<\/code><\/pre>\n<p>\u6309\u7167\u6700\u4f73\u5b9e\u8df5\uff0c\u6211\u4eec\u5c06\u5728docs\u5e94\u7528\u7a0b\u5e8f\u4e2d\u6dfb\u52a0include\u6307\u4ee4\u3002\uff08\u5b66\u4e60\u4e86\u4e3a\u6bcf\u4e2a\u5e94\u7528\u7a0b\u5e8f\u5b9a\u4e49urls.py\u6587\u4ef6\u7684\u505a\u6cd5\uff09<\/p>\n<pre class=\"post-pre\"><code><span class=\"s\">\"\"\"\r\nsettings.py\r\n\"\"\"<\/span>\r\n<span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<span class=\"n\">TIME_ZONE<\/span> <span class=\"o\">=<\/span> <span class=\"s\">'Asia\/Tokyo'<\/span>\r\n<span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<span class=\"c1\"># MkDocs\u306e\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\r\n<\/span><span class=\"n\">DOCS_DIR<\/span> <span class=\"o\">=<\/span> <span class=\"n\">os<\/span><span class=\"p\">.<\/span><span class=\"n\">path<\/span><span class=\"p\">.<\/span><span class=\"n\">join<\/span><span class=\"p\">(<\/span><span class=\"n\">BASE_DIR<\/span><span class=\"p\">,<\/span> <span class=\"s\">'docs\/static\/docs'<\/span><span class=\"p\">)<\/span>\r\n<span class=\"n\">DOCS_STATIC_NAMESPACE<\/span> <span class=\"o\">=<\/span> <span class=\"n\">os<\/span><span class=\"p\">.<\/span><span class=\"n\">path<\/span><span class=\"p\">.<\/span><span class=\"n\">basename<\/span><span class=\"p\">(<\/span><span class=\"n\">DOCS_DIR<\/span><span class=\"p\">)<\/span>\r\n<\/code><\/pre>\n<p>\u5728settings.py\u4e2d\u66f4\u6539\u65f6\u533a\uff0c\u5e76\u5b9a\u4e49MkDocs\u76ee\u5f55\u7684static_namespace\u3002<br \/>\n\u203b LANGUAGE_CODE\u6ca1\u6709\u7279\u522b\u66f4\u6539\u3002<\/p>\n<h2>\u6dfb\u52a0\u8ba4\u8bc1\u5e94\u7528\u7a0b\u5e8f<\/h2>\n<h3>\u521b\u5efa\u4e00\u4e2aaccounts\u5e94\u7528\u7a0b\u5e8f<\/h3>\n<pre class=\"post-pre\"><code><span class=\"go\">python manage.py startapp accounts\r\n<\/span><\/code><\/pre>\n<h3>\u6dfb\u52a0\u8ba4\u8bc1<\/h3>\n<h4>\u4f7f\u7528Django\u7684\u8eab\u4efd\u9a8c\u8bc1\u529f\u80fd\u3002<\/h4>\n<p>\u56e0\u4e3aDjango\u5df2\u7ecf\u81ea\u5e26\u4e86\u767b\u5f55\u548c\u767b\u51fa\u529f\u80fd\uff0c\u6240\u4ee5\u6211\u6253\u7b97\u4f7f\u7528\u5b83\u4eec\u3002<\/p>\n<h4>\u521b\u5efa\u81ea\u5b9a\u4e49\u7684User\u6a21\u578b<\/h4>\n<p>Django\u5185\u7f6e\u4e86\u8eab\u4efd\u9a8c\u8bc1\u529f\u80fd\uff0c\u5e76\u4e14\u5df2\u7ecf\u5177\u6709User\u6a21\u578b\u3002\u4f46\u662f\uff0c\u5982\u679c\u76f4\u63a5\u4f7f\u7528\u8fd9\u4e2a\u6a21\u578b\uff0c\u4ee5\u540e\u60f3\u8981\u66f4\u6539\u5b83\u4f1a\u5f88\u56f0\u96be\uff08\u542c\u8bf4\uff09\u3002\u56e0\u6b64\uff0c\u6211\u4eec\u9700\u8981\u5b9a\u4e49\u4e00\u4e2a\u6ca1\u6709\u8fdb\u884c\u81ea\u5b9a\u4e49\u7684\u81ea\u5b9a\u4e49User\u6a21\u578b\u3002<\/p>\n<p>\u76f4\u63a5\u590d\u5236auth\u6a21\u5757\u7684User\u6a21\u578b\uff0c\u5e76<\/p>\n<pre class=\"post-pre\"><code>\r\n<span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<span class=\"k\">class<\/span> <span class=\"nc\">User<\/span><span class=\"p\">(<\/span><span class=\"n\">AbstractBaseUser<\/span><span class=\"p\">,<\/span> <span class=\"n\">PermissionsMixin<\/span><span class=\"p\">):<\/span>\r\n<span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<span class=\"err\">\u3000\u3000\u3000\u3000\u3000\u3000\u3000\u3000<\/span><span class=\"c1\"># is_mkdocs\u3092\u8ffd\u52a0\uff08True\u306e\u30e6\u30fc\u30b6\u3060\u3051MkDocs\u3092\u8868\u793a\u3055\u305b\u308b\uff09\r\n<\/span>    <span class=\"n\">is_mkdocs<\/span> <span class=\"o\">=<\/span> <span class=\"n\">models<\/span><span class=\"p\">.<\/span><span class=\"n\">BooleanField<\/span><span class=\"p\">(<\/span>\r\n        <span class=\"n\">_<\/span><span class=\"p\">(<\/span><span class=\"s\">'MkDocs User'<\/span><span class=\"p\">),<\/span>\r\n        <span class=\"n\">default<\/span><span class=\"o\">=<\/span><span class=\"bp\">False<\/span><span class=\"p\">,<\/span>\r\n        <span class=\"n\">help_text<\/span><span class=\"o\">=<\/span><span class=\"n\">_<\/span><span class=\"p\">(<\/span><span class=\"s\">'the user can use MkDocs site.'<\/span><span class=\"p\">),<\/span>\r\n    <span class=\"p\">)<\/span>\r\n\r\n    <span class=\"k\">class<\/span> <span class=\"nc\">Meta<\/span><span class=\"p\">:<\/span>\r\n        <span class=\"n\">verbose_name<\/span> <span class=\"o\">=<\/span> <span class=\"n\">_<\/span><span class=\"p\">(<\/span><span class=\"s\">'user'<\/span><span class=\"p\">)<\/span>\r\n        <span class=\"n\">verbose_name_plural<\/span> <span class=\"o\">=<\/span> <span class=\"n\">_<\/span><span class=\"p\">(<\/span><span class=\"s\">'users'<\/span><span class=\"p\">)<\/span>\r\n        <span class=\"c1\"># \u62bd\u8c61\u30e2\u30c7\u30eb\u8a2d\u5b9a\u3092\u30b3\u30e1\u30f3\u30c8\u5316\r\n<\/span>        <span class=\"c1\"># abstract=True\r\n<\/span><span class=\"err\">\uff65\uff65\uff65<\/span>\r\n<\/code><\/pre>\n<p>\u6dfb\u52a0\u8fd9\u4e2a\u6a21\u578b<\/p>\n<p>\u5728Setting.py\u6587\u4ef6\u4e2d\u6dfb\u52a0\u8ba4\u8bc1\u6a21\u578b<\/p>\n<pre class=\"post-pre\"><code><span class=\"n\">AUTH_USER_MODEL<\/span> <span class=\"o\">=<\/span> <span class=\"s\">'accounts.User'<\/span>\r\n<\/code><\/pre>\n<p>\u6dfb\u52a0\u3002<br \/>\n\u5728\u6b64\u4e4b\u540e\uff0c<\/p>\n<pre class=\"post-pre\"><code><span class=\"go\">django manage.py makemigrations\r\ndjango manage.py migrate\r\n<\/span><\/code><\/pre>\n<p>\u8fdb\u884c\u8fc1\u79fb\u65f6\uff0c\u5c06\u521b\u5efa\u81ea\u5b9a\u4e49\u7528\u6237\u8868\u3002<\/p>\n<h3>\u521b\u5efa\u767b\u5f55\u548c\u767b\u51fa\u9875\u9762<\/h3>\n<p>\u8981\u7b80\u5355\u5730\u5b9e\u73b0\u767b\u5f55\u548c\u767b\u51fa\u529f\u80fd\uff0c\u9700\u8981\u5728urls.py\u6587\u4ef6\u7684URL\u6a21\u5f0f\u4e2d\u6dfb\u52a0<\/p>\n<pre class=\"post-pre\"><code><span class=\"n\">path<\/span><span class=\"p\">(<\/span><span class=\"s\">'accounts\/'<\/span><span class=\"p\">,<\/span> <span class=\"n\">include<\/span><span class=\"p\">(<\/span><span class=\"s\">'django.contrib.auth.urls'<\/span><span class=\"p\">)),<\/span> \r\n<\/code><\/pre>\n<p>\u5982\u679c\u4f60\u60f3\u8981\u81ea\u5b9a\u4e49\u7684\u8bdd\uff0c\u53ef\u4ee5\u6dfb\u52a0\u4e0a\u53bb\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"n\">path<\/span><span class=\"p\">(<\/span><span class=\"s\">'accounts\/'<\/span><span class=\"p\">,<\/span> <span class=\"n\">include<\/span><span class=\"p\">(<\/span><span class=\"s\">'accounts.urls'<\/span><span class=\"p\">)),<\/span>\r\n<span class=\"n\">path<\/span><span class=\"p\">(<\/span><span class=\"s\">'accounts\/'<\/span><span class=\"p\">,<\/span> <span class=\"n\">include<\/span><span class=\"p\">(<\/span><span class=\"s\">'django.contrib.auth.urls'<\/span><span class=\"p\">)),<\/span> \r\n<\/code><\/pre>\n<p>\u5982\u679c\u8981\u6dfb\u52a0accounts\u7684urls.py\u548cviews.py\u7b49\uff0c\u53ef\u4ee5\u8fd9\u6837\u505a\u3002<br \/>\n\u53e6\u5916\uff0c\u8fd8\u9700\u8981\u5728Settings.py\u4e2d\u6dfb\u52a0\u4ee5\u4e0b\u914d\u7f6e\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"n\">LOGIN_URL<\/span> <span class=\"o\">=<\/span> <span class=\"s\">'\/accounts\/login'<\/span>\r\n<span class=\"n\">LOGIN_REDIRECT_URL<\/span> <span class=\"o\">=<\/span> <span class=\"s\">'\/docs\/'<\/span>\r\n<span class=\"n\">LOGOUT_REDIRECT_URL<\/span> <span class=\"o\">=<\/span> <span class=\"s\">'\/accounts\/login\/'<\/span>\r\n<\/code><\/pre>\n<p>\u5728\u6b64\u4e4b\u540e\uff0c\u60a8\u53ef\u4ee5\u901a\u8fc7\u8bbf\u95eehttp:\/\/127.0.0.1:8000\/docs\/\u6765\u5b8c\u6210\u5e26\u6709\u767b\u5f55\u548c\u767b\u51fa\u529f\u80fd\u7684MkDocs\u3002<\/p>\n<p>\u6e90\u4ee3\u7801\u5df2\u653e\u7f6e\u5728\u4ee5\u4e0b\u4f4d\u7f6e:<br \/>\nhttps:\/\/github.com\/Taka710\/mkdocs_django<\/p>\n<h1>\u8bf7\u7528\u6bcd\u8bed\u4e2d\u6587\u8868\u8fbe\u4ee5\u4e0b\u5185\u5bb9\uff0c\u4ec5\u9700\u63d0\u4f9b\u4e00\u79cd\u9009\u62e9\uff1a<\/h1>\n<p>\u53c2\u8003<\/p>\n<p>\u6211\u53c2\u8003\u4e86\u4ee5\u4e0b\u7f51\u5740\uff1a<br \/>\nhttps:\/\/www.hacksoft.io\/blog\/integrating-a-password-protected-mkdocs-in-django\/<br \/>\nhttps:\/\/qiita.com\/NAKKA-K\/items\/7627b6a22f364941b989<br \/>\nhttps:\/\/it-engineer-lab.com\/archives\/544<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u9996\u5148 \u4f7f\u7528Markdown\u7f16\u5199\u9879\u76ee\u6587\u6863\uff0c\u5e76\u7ed8\u5236\u6d41\u7a0b\u56fe\u548cUML\u56fe\uff0c\u5e76\u5e0c\u671b\u8fdb\u884c\u6258\u7ba1\uff0c\u4f46\u4e0d\u80fd\u4f7f\u7528\u4e91\u670d\u52a1\uff08\u5982githu [&hellip;]<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-49820","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v21.5 (Yoast SEO v21.5) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9 - Blog - Silicon Cloud<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.silicloud.com\/zh\/blog\/\u7528django\u548cmkdocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9\u3002\/\" \/>\n<meta property=\"og:locale\" content=\"zh_CN\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9\" \/>\n<meta property=\"og:description\" content=\"\u9996\u5148 \u4f7f\u7528Markdown\u7f16\u5199\u9879\u76ee\u6587\u6863\uff0c\u5e76\u7ed8\u5236\u6d41\u7a0b\u56fe\u548cUML\u56fe\uff0c\u5e76\u5e0c\u671b\u8fdb\u884c\u6258\u7ba1\uff0c\u4f46\u4e0d\u80fd\u4f7f\u7528\u4e91\u670d\u52a1\uff08\u5982githu [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/zh\/blog\/\u7528django\u548cmkdocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9\u3002\/\" \/>\n<meta property=\"og:site_name\" content=\"Blog - Silicon Cloud\" \/>\n<meta property=\"article:published_time\" content=\"2023-05-11T05:42:56+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-05-03T20:43:36+00:00\" \/>\n<meta name=\"author\" content=\"\u79d1, \u96c5\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"\u4f5c\u8005\" \/>\n\t<meta name=\"twitter:data1\" content=\"\u79d1, \u96c5\" \/>\n\t<meta name=\"twitter:label2\" content=\"\u9884\u8ba1\u9605\u8bfb\u65f6\u95f4\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 \u5206\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/\",\"url\":\"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/\",\"name\":\"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9 - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#website\"},\"datePublished\":\"2023-05-11T05:42:56+00:00\",\"dateModified\":\"2024-05-03T20:43:36+00:00\",\"author\":{\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/41e222757cdd2a3365361328bd79970a\"},\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/#breadcrumb\"},\"inLanguage\":\"zh-Hans\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"\u9996\u9875\",\"item\":\"https:\/\/www.silicloud.com\/zh\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#website\",\"url\":\"https:\/\/www.silicloud.com\/zh\/blog\/\",\"name\":\"Blog - Silicon Cloud\",\"description\":\"\",\"inLanguage\":\"zh-Hans\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/41e222757cdd2a3365361328bd79970a\",\"name\":\"\u79d1, \u96c5\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"zh-Hans\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/1b2d3e00a7df03689797ebd4af8c5827ba5af936849a71050ec331f4cf902c5d?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/1b2d3e00a7df03689797ebd4af8c5827ba5af936849a71050ec331f4cf902c5d?s=96&d=mm&r=g\",\"caption\":\"\u79d1, \u96c5\"},\"url\":\"https:\/\/www.silicloud.com\/zh\/blog\/author\/keya\/\"},{\"@type\":\"ImageObject\",\"inLanguage\":\"zh-Hans\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/#local-main-organization-logo\",\"url\":\"\",\"contentUrl\":\"\",\"caption\":\"Blog - Silicon Cloud\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9 - Blog - Silicon Cloud","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.silicloud.com\/zh\/blog\/\u7528django\u548cmkdocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9\u3002\/","og_locale":"zh_CN","og_type":"article","og_title":"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9","og_description":"\u9996\u5148 \u4f7f\u7528Markdown\u7f16\u5199\u9879\u76ee\u6587\u6863\uff0c\u5e76\u7ed8\u5236\u6d41\u7a0b\u56fe\u548cUML\u56fe\uff0c\u5e76\u5e0c\u671b\u8fdb\u884c\u6258\u7ba1\uff0c\u4f46\u4e0d\u80fd\u4f7f\u7528\u4e91\u670d\u52a1\uff08\u5982githu [&hellip;]","og_url":"https:\/\/www.silicloud.com\/zh\/blog\/\u7528django\u548cmkdocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9\u3002\/","og_site_name":"Blog - Silicon Cloud","article_published_time":"2023-05-11T05:42:56+00:00","article_modified_time":"2024-05-03T20:43:36+00:00","author":"\u79d1, \u96c5","twitter_card":"summary_large_image","twitter_misc":{"\u4f5c\u8005":"\u79d1, \u96c5","\u9884\u8ba1\u9605\u8bfb\u65f6\u95f4":"2 \u5206"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/","url":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/","name":"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9 - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/zh\/blog\/#website"},"datePublished":"2023-05-11T05:42:56+00:00","dateModified":"2024-05-03T20:43:36+00:00","author":{"@id":"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/41e222757cdd2a3365361328bd79970a"},"breadcrumb":{"@id":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/#breadcrumb"},"inLanguage":"zh-Hans","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"\u9996\u9875","item":"https:\/\/www.silicloud.com\/zh\/blog\/"},{"@type":"ListItem","position":2,"name":"\u7528Django\u548cMkDocs\u8f7b\u677e\u6784\u5efa\u6587\u6863\u7f51\u7ad9"}]},{"@type":"WebSite","@id":"https:\/\/www.silicloud.com\/zh\/blog\/#website","url":"https:\/\/www.silicloud.com\/zh\/blog\/","name":"Blog - Silicon Cloud","description":"","inLanguage":"zh-Hans"},{"@type":"Person","@id":"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/41e222757cdd2a3365361328bd79970a","name":"\u79d1, \u96c5","image":{"@type":"ImageObject","inLanguage":"zh-Hans","@id":"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/1b2d3e00a7df03689797ebd4af8c5827ba5af936849a71050ec331f4cf902c5d?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/1b2d3e00a7df03689797ebd4af8c5827ba5af936849a71050ec331f4cf902c5d?s=96&d=mm&r=g","caption":"\u79d1, \u96c5"},"url":"https:\/\/www.silicloud.com\/zh\/blog\/author\/keya\/"},{"@type":"ImageObject","inLanguage":"zh-Hans","@id":"https:\/\/www.silicloud.com\/zh\/blog\/%e7%94%a8django%e5%92%8cmkdocs%e8%bd%bb%e6%9d%be%e6%9e%84%e5%bb%ba%e6%96%87%e6%a1%a3%e7%bd%91%e7%ab%99%e3%80%82\/#local-main-organization-logo","url":"","contentUrl":"","caption":"Blog - Silicon Cloud"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts\/49820","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/comments?post=49820"}],"version-history":[{"count":2,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts\/49820\/revisions"}],"predecessor-version":[{"id":96184,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts\/49820\/revisions\/96184"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/media?parent=49820"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/categories?post=49820"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/tags?post=49820"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}