{"id":594153,"date":"2024-06-07T12:07:22","date_gmt":"2024-06-07T04:07:22","guid":{"rendered":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/594153.html"},"modified":"2024-06-07T12:07:27","modified_gmt":"2024-06-07T04:07:27","slug":"%e5%89%8d%e7%ab%af%e6%96%87%e6%a1%a3%e7%9a%84%e7%ae%a1%e7%90%86%e8%bd%af%e4%bb%b6%e5%8f%ab%e4%bb%80%e4%b9%88","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/594153.html","title":{"rendered":"\u524d\u7aef\u6587\u6863\u7684\u7ba1\u7406\u8f6f\u4ef6\u53eb\u4ec0\u4e48"},"content":{"rendered":"

\"\u524d\u7aef\u6587\u6863\u7684\u7ba1\u7406\u8f6f\u4ef6\u53eb\u4ec0\u4e48\"<\/p>\n

\u524d\u7aef\u6587\u6863\u7684\u7ba1\u7406\u8f6f\u4ef6\u6709\u591a\u4e2a\u9009\u62e9\uff0c\u5305\u62ecGitBook\u3001Docusaurus\u3001MkDocs\u3001Sphinx<\/strong>\u7b49\u3002\u8fd9\u4e9b\u5de5\u5177\u5404\u6709\u7279\u70b9\uff0c\u4f46\u5171\u540c\u76ee\u7684\u662f\u5e2e\u52a9\u5f00\u53d1\u8005\u4ee5\u9ad8\u6548\u3001\u7ed3\u6784\u5316\u7684\u65b9\u5f0f\u521b\u5efa\u3001\u7ef4\u62a4\u548c\u53d1\u5e03\u6587\u6863\u3002\u5176\u4e2d\uff0cGitBook<\/strong>\u4ee5\u5176\u6613\u7528\u6027\u548c\u4e0eGitHub\u7684\u7d27\u5bc6\u96c6\u6210\u800c\u5e7f\u53d7\u6b22\u8fce\u3002\u5b83\u4e0d\u4ec5\u652f\u6301Markdown\u548c\u5bcc\u6587\u672c\u7f16\u8f91\uff0c\u8fd8\u63d0\u4f9b\u4e86\u7248\u672c\u63a7\u5236\u3001\u591a\u4eba\u534f\u4f5c\u7b49\u529f\u80fd\uff0c\u975e\u5e38\u9002\u5408\u56e2\u961f\u534f\u4f5c\u9879\u76ee\u6587\u6863\u7684\u7f16\u5199\u548c\u7ba1\u7406\u3002<\/p>\n<\/p>\n

\u4e00\u3001GITBOOK<\/h3>\n<\/p>\n

GitBook\u662f\u524d\u7aef\u6587\u6863\u7ba1\u7406\u7684\u4e00\u6b3e\u6d41\u884c\u8f6f\u4ef6\uff0c\u5b83\u57fa\u4e8eGit\u7248\u672c\u63a7\u5236\u7cfb\u7edf\uff0c\u652f\u6301Markdown\u8bed\u6cd5\uff0c\u8ba9\u6587\u6863\u7684\u7f16\u5199\u3001\u534f\u4f5c\u548c\u7248\u672c\u63a7\u5236\u53d8\u5f97\u7b80\u5355\u9ad8\u6548\u3002\u5b83\u80fd\u591f\u5c06\u6587\u6863\u5185\u5bb9\u81ea\u52a8\u540c\u6b65\u5230Git\u4ed3\u5e93\u4e2d\uff0c\u652f\u6301\u5728\u7ebf\u7f16\u8f91\u548c\u79bb\u7ebf\u7f16\u8f91\u4e24\u79cd\u6a21\u5f0f\uff0c\u975e\u5e38\u9002\u5408\u56e2\u961f\u534f\u4f5c\u3002<\/p>\n<\/p>\n

GitBook\u7684\u4e00\u4e2a\u663e\u8457\u7279\u70b9\u662f\u5b83\u7684\u63d2\u4ef6\u7cfb\u7edf\u3002\u7528\u6237\u53ef\u4ee5\u901a\u8fc7\u5b89\u88c5\u4e0d\u540c\u7684\u63d2\u4ef6\u6765\u6269\u5c55GitBook\u7684\u529f\u80fd\uff0c\u6bd4\u5982\u641c\u7d22\u4f18\u5316\u3001\u8bc4\u8bba\u7cfb\u7edf\u3001\u5185\u5bb9\u5206\u6790\u7b49\u3002\u8fd9\u79cd\u7075\u6d3b\u6027\u4f7f\u5f97GitBook\u4e0d\u4ec5\u9002\u7528\u4e8e\u524d\u7aef\u6587\u6863\u7684\u7ba1\u7406\uff0c\u4e5f\u9002\u7528\u4e8e\u4e66\u7c4d\u3001\u6559\u7a0b\u3001API\u6587\u6863\u7b49\u591a\u79cd\u573a\u666f\u3002<\/p>\n<\/p>\n

\u4e8c\u3001DOCUSAURUS<\/h3>\n<\/p>\n

Docusaurus\u662f\u7531Facebook\u5f00\u6e90\u7684\u4e00\u6b3e\u6587\u6863\u7ad9\u70b9\u751f\u6210\u5668\uff0c\u7279\u522b\u9002\u5408\u7528\u4e8e\u7ba1\u7406\u9879\u76ee\u6587\u6863\u3002\u5b83\u57fa\u4e8eReact\u5f00\u53d1\uff0c\u652f\u6301Markdown\u683c\u5f0f\uff0c\u4e14\u80fd\u591f\u8f7b\u677e\u751f\u6210\u9759\u6001\u7f51\u7ad9\u3002Docusaurus\u7684\u8bbe\u8ba1\u521d\u8877\u662f\u7b80\u5316\u6587\u6863\u7f51\u7ad9\u7684\u6784\u5efa\u8fc7\u7a0b\uff0c\u8ba9\u5f00\u53d1\u8005\u80fd\u591f\u4e13\u6ce8\u4e8e\u7f16\u5199\u5185\u5bb9\u3002<\/p>\n<\/p>\n

Docusaurus\u652f\u6301\u7248\u672c\u63a7\u5236\uff0c\u53ef\u4ee5\u5f88\u597d\u5730\u7ba1\u7406\u6587\u6863\u7684\u4e0d\u540c\u7248\u672c\u3002\u6b64\u5916\uff0c\u5b83\u5185\u7f6e\u4e86\u641c\u7d22\u529f\u80fd\uff0c\u4f7f\u5f97\u7528\u6237\u80fd\u591f\u5feb\u901f\u627e\u5230\u9700\u8981\u7684\u4fe1\u606f\u3002Docusaurus\u8fd8\u652f\u6301\u56fd\u9645\u5316\uff0c\u5e2e\u52a9\u5f00\u53d1\u8005\u521b\u5efa\u591a\u8bed\u8a00\u6587\u6863\uff0c\u62d3\u5c55\u5168\u7403\u7528\u6237\u3002<\/p>\n<\/p>\n

\u4e09\u3001MKDOCS<\/h3>\n<\/p>\n

MkDocs\u662f\u4e00\u4e2a\u5feb\u901f\u3001\u7b80\u5355\u4e14\u5b8c\u5168\u57fa\u4e8eMarkdown\u7684\u9759\u6001\u7ad9\u70b9\u751f\u6210\u5668\uff0c\u4e13\u4e3a\u9879\u76ee\u6587\u6863\u8bbe\u8ba1\u3002\u5b83\u901a\u8fc7\u7b80\u5355\u7684\u914d\u7f6e\u6587\u4ef6\uff0c\u652f\u6301\u591a\u79cd\u4e3b\u9898\u548c\u63d2\u4ef6\uff0c\u53ef\u4ee5\u8f7b\u677e\u5730\u751f\u6210\u4e00\u4e2a\u5b8c\u6574\u7684\u3001\u98ce\u683c\u7edf\u4e00\u7684\u6587\u6863\u7f51\u7ad9\u3002<\/p>\n<\/p>\n

MkDocs\u7684\u5f3a\u9879\u5728\u4e8e\u5176\u901f\u5ea6\u548c\u7b80\u6d01\u6027\u3002\u5b83\u4f7f\u7528Python\u5f00\u53d1\uff0c\u5b89\u88c5\u548c\u914d\u7f6e\u90fd\u975e\u5e38\u7b80\u5355\u3002\u5bf9\u4e8e\u8ffd\u6c42\u9ad8\u6548\u6587\u6863\u7ba1\u7406\u548c\u5e0c\u671b\u5feb\u901f\u642d\u5efa\u9879\u76ee\u6587\u6863\u7ad9\u70b9\u7684\u56e2\u961f\u6765\u8bf4\uff0cMkDocs\u662f\u4e00\u4e2a\u975e\u5e38\u597d\u7684\u9009\u62e9\u3002<\/p>\n<\/p>\n

\u56db\u3001SPHINX<\/h3>\n<\/p>\n

Sphinx\u662f\u4e00\u4e2a\u5f3a\u5927\u7684\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u6700\u521d\u88ab\u8bbe\u8ba1\u7528\u6765\u4e3aPython\u9879\u76ee\u521b\u5efa\u6587\u6863\uff0c\u4f46\u73b0\u5728\u5df2\u7ecf\u5e7f\u6cdb\u5e94\u7528\u4e8e\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\u7684\u6587\u6863\u7f16\u5199\u4e2d\u3002\u5b83\u652f\u6301reStructuredText\u548cMarkdown\u4e24\u79cd\u6807\u8bb0\u8bed\u8a00\uff0c\u53ef\u4ee5\u751f\u6210\u591a\u79cd\u683c\u5f0f\u7684\u6587\u6863\uff0c\u5305\u62ecHTML\u3001PDF\u548cePub\u7b49\u3002<\/p>\n<\/p>\n

Sphinx\u7684\u4e00\u4e2a\u91cd\u8981\u7279\u6027\u662f\u5b83\u7684\u6269\u5c55\u6027\u3002\u901a\u8fc7\u5b89\u88c5\u4e0d\u540c\u7684\u6269\u5c55\uff0cSphinx\u53ef\u4ee5\u652f\u6301\u81ea\u52a8\u751f\u6210\u6587\u6863\u7ed3\u6784\u3001\u96c6\u6210\u7248\u672c\u63a7\u5236\u3001\u751f\u6210API\u6587\u6863\u7b49\u529f\u80fd\u3002\u6b64\u5916\uff0cSphinx\u63d0\u4f9b\u4e86\u5f3a\u5927\u7684\u641c\u7d22\u529f\u80fd\u548c\u56fd\u9645\u5316\u652f\u6301\uff0c\u4f7f\u5f97\u6587\u6863\u7ba1\u7406\u548c\u53d1\u5e03\u66f4\u52a0\u9ad8\u6548\u3002<\/p>\n<\/p>\n

\u4e94\u3001\u603b\u7ed3<\/h3>\n<\/p>\n

\u9009\u62e9\u9002\u5408\u56e2\u961f\u7684\u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\u662f\u63d0\u9ad8\u6587\u6863\u7f16\u5199\u548c\u7ba1\u7406\u6548\u7387\u7684\u5173\u952e\u3002GitBook\u3001Docusaurus\u3001MkDocs\u3001Sphinx<\/strong>\u5404\u6709\u5343\u79cb\uff0c\u4ece\u6613\u7528\u6027\u3001\u529f\u80fd\u6027\u3001\u6269\u5c55\u6027\u548c\u9002\u7528\u8303\u56f4\u7b49\u591a\u4e2a\u89d2\u5ea6\u51fa\u53d1\uff0c\u56e2\u961f\u53ef\u4ee5\u6839\u636e\u81ea\u8eab\u7684\u9700\u6c42\u548c\u504f\u597d\u505a\u51fa\u9009\u62e9\u3002\u65e0\u8bba\u9009\u62e9\u54ea\u4e00\u6b3e\u5de5\u5177\uff0c\u91cd\u8981\u7684\u662f\u80fd\u591f\u5e2e\u52a9\u56e2\u961f\u66f4\u597d\u5730\u534f\u4f5c\u3001\u7ba1\u7406\u548c\u5206\u4eab\u77e5\u8bc6\uff0c\u4ece\u800c\u63a8\u52a8\u9879\u76ee\u7684\u6210\u529f\u3002<\/p>\n<\/p>\n

\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n

1. \u4ec0\u4e48\u662f\u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\uff1f<\/strong>
\n\u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\u662f\u4e00\u79cd\u7528\u4e8e\u7ec4\u7ec7\u3001\u5b58\u50a8\u548c\u5171\u4eab\u524d\u7aef\u5f00\u53d1\u56e2\u961f\u7684\u6587\u6863\u548c\u8d44\u6599\u7684\u5de5\u5177\u3002\u5b83\u53ef\u4ee5\u5e2e\u52a9\u56e2\u961f\u6210\u5458\u66f4\u597d\u5730\u7ba1\u7406\u548c\u534f\u4f5c\uff0c\u63d0\u9ad8\u5de5\u4f5c\u6548\u7387\u3002<\/p>\n

2. \u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\u6709\u54ea\u4e9b\u63a8\u8350\u7684\u9009\u62e9\uff1f<\/strong>
\n\u6709\u5f88\u591a\u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\u53ef\u4ee5\u9009\u62e9\uff0c\u5176\u4e2d\u4e00\u4e9b\u53d7\u6b22\u8fce\u7684\u9009\u62e9\u5305\u62ecGitBook\u3001Docusaurus\u548cConfluence\u7b49\u3002\u8fd9\u4e9b\u8f6f\u4ef6\u63d0\u4f9b\u4e86\u4e30\u5bcc\u7684\u529f\u80fd\uff0c\u5982\u7248\u672c\u63a7\u5236\u3001\u591a\u4eba\u534f\u4f5c\u3001\u6587\u6863\u641c\u7d22\u7b49\uff0c\u53ef\u4ee5\u6ee1\u8db3\u4e0d\u540c\u56e2\u961f\u7684\u9700\u6c42\u3002<\/p>\n

3. \u5982\u4f55\u9009\u62e9\u9002\u5408\u81ea\u5df1\u56e2\u961f\u7684\u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\uff1f<\/strong>
\n\u9009\u62e9\u9002\u5408\u81ea\u5df1\u56e2\u961f\u7684\u524d\u7aef\u6587\u6863\u7ba1\u7406\u8f6f\u4ef6\u9700\u8981\u8003\u8651\u591a\u4e2a\u56e0\u7d20\u3002\u9996\u5148\uff0c\u8981\u6839\u636e\u56e2\u961f\u7684\u89c4\u6a21\u548c\u9700\u6c42\u6765\u786e\u5b9a\u6240\u9700\u7684\u529f\u80fd\u548c\u6269\u5c55\u6027\u3002\u5176\u6b21\uff0c\u8981\u8003\u8651\u8f6f\u4ef6\u7684\u6613\u7528\u6027\u548c\u7528\u6237\u754c\u9762\u8bbe\u8ba1\u662f\u5426\u7b26\u5408\u56e2\u961f\u6210\u5458\u7684\u4e60\u60ef\u3002\u6700\u540e\uff0c\u8fd8\u8981\u8003\u8651\u8f6f\u4ef6\u7684\u7a33\u5b9a\u6027\u548c\u5b89\u5168\u6027\uff0c\u786e\u4fdd\u80fd\u591f\u4fdd\u62a4\u6587\u6863\u548c\u8d44\u6599\u7684\u5b89\u5168\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"\u524d\u7aef\u6587\u6863\u7684\u7ba1\u7406\u8f6f\u4ef6\u6709\u591a\u4e2a\u9009\u62e9\uff0c\u5305\u62ecGitBook\u3001Docusaurus\u3001MkDocs\u3001Sphinx\u7b49\u3002\u8fd9\u4e9b\u5de5\u5177 […]","protected":false},"author":3,"featured_media":594162,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/594153"}],"collection":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=594153"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/594153\/revisions"}],"predecessor-version":[{"id":594163,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/594153\/revisions\/594163"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/594162"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=594153"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=594153"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=594153"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}