{"id":352,"date":"2026-07-15T17:00:01","date_gmt":"2026-07-15T09:00:01","guid":{"rendered":"https:\/\/numsimlab.com\/?p=352"},"modified":"2026-07-15T17:00:01","modified_gmt":"2026-07-15T09:00:01","slug":"repo-wiki-%e5%ae%8c%e6%95%b4%e6%8c%87%e5%8d%97","status":"publish","type":"post","link":"https:\/\/numsimlab.com\/?p=352","title":{"rendered":"Repo Wiki \u5b8c\u6574\u6307\u5357"},"content":{"rendered":"\n\n\n\n\n\nRepo Wiki \u5b8c\u6574\u6307\u5357 \u00b7 Repository Wiki Full Guide<\/title>\n<style>\n*,*::before,*::after{box-sizing:border-box;margin:0;padding:0}\nhtml{scroll-behavior:smooth}\n:root{\n --bg:#f8f9fa;--bg2:#fff;--ink:#1a1a2e;--muted:#6c7086;--rule:#e2e4eb;\n --accent:#2563eb;--accent2:#16a34a;--accent3:#dc2626;--accent4:#d97706;--accent5:#7c3aed;\n --card-bg:#fff;--code-bg:#f1f3f5;\n --tag-g:#dcfce7;--tag-g-t:#166534;--tag-b:#dbeafe;--tag-b-t:#1e40af;\n --tag-r:#fee2e2;--tag-r-t:#991b1b;--tag-y:#fef9c3;--tag-y-t:#713f12;--tag-p:#f3e8ff;--tag-p-t:#581c87;\n --shadow:0 1px 3px rgba(0,0,.08);--radius:8px;--max-w:940px\n}\n[data-theme=\"dark\"]{\n --bg:#0b0b1a;--bg2:#16162a;--ink:#e2e4f0;--muted:#7f8396;--rule:#26263e;\n --accent:#60a5fa;--accent2:#4ade80;--accent3:#f87171;--accent4:#fbbf24;--accent5:#a78bfa;\n --card-bg:#16162a;--code-bg:#1e1e36;\n --tag-g:#14532d;--tag-g-t:#bbf7d0;--tag-b:#1e3a5f;--tag-b-t:#bfdbfe;\n --tag-r:#7f1d1d;--tag-r-t:#fecaca;--tag-y:#713f12;--tag-y-t:#fef08a;\n --tag-p:#3b1f6e;--tag-p-t:#e9d5ff;\n --shadow:0 1px 3px rgba(0,0,.3)\n}\nbody{font-family:-apple-system,BlinkMacSystemFont,\"Segoe UI\",\"Noto Sans SC\",\"PingFang SC\",\"Microsoft YaHei\",sans-serif;background:var(--bg);color:var(--ink);line-height:1.7;font-size:15px;transition:background .3s,color .3s}\nheader{position:fixed;top:0;left:0;right:0;z-index:100;background:var(--bg2);border-bottom:1px solid var(--rule);backdrop-filter:blur(12px);-webkit-backdrop-filter:blur(12px);transition:background .3s}\n.header-inner{max-width:var(--max-w);margin:0 auto;display:flex;align-items:center;justify-content:space-between;padding:0 1.5rem;height:56px}\n.logo{font-weight:700;font-size:.95rem;color:var(--accent);display:flex;align-items:center;gap:.4rem}\n.controls{display:flex;align-items:center;gap:.5rem}\n.lang-switch{display:flex;border:1px solid var(--rule);border-radius:6px;overflow:hidden}\n.lang-switch button{background:0 0;border:none;color:var(--muted);padding:.3rem .7rem;font-size:.8rem;cursor:pointer;transition:all .2s;font-family:inherit}\n.lang-switch button.active{background:var(--accent);color:#fff}\n.lang-switch button:not(.active):hover{color:var(--ink);background:var(--rule)}\n.theme-toggle{background:0 0;border:1px solid var(--rule);border-radius:6px;color:var(--muted);width:34px;height:34px;font-size:1rem;cursor:pointer;display:flex;align-items:center;transition:all .2s}\n.theme-toggle:hover{color:var(--ink);background:var(--rule)}\nmain{max-width:var(--max-w);margin:0 auto;padding:80px 1.5rem 3rem}\n.lang-section{display:none}.lang-section.active{display:block}\nh1{font-size:1.9rem;font-weight:800;line-height:1.3;margin-bottom:.5rem;letter-spacing:-.02em}\nh1 .sub{display:block;font-size:.85rem;font-weight:400;color:var(--muted);margin-top:.25rem;letter-spacing:0}\nh2{font-size:1.35rem;font-weight:700;margin:2.5rem 0 1rem;padding-bottom:.5rem;border-bottom:2px solid var(--accent);letter-spacing:-.01em}\nh3{font-size:1.05rem;font-weight:600;margin:1.5rem 0 .6rem;color:var(--accent)}\nh4{font-size:.95rem;font-weight:600;margin:1rem 0 .4rem;color:var(--ink)}\np{margin-bottom:.8rem}\na{color:var(--accent);text-decoration:none}a:hover{text-decoration:underline}\n.hero{text-align:center;padding:2rem 0 1rem}\n.hero p{font-size:1rem;color:var(--muted);max-width:700px;margin:0 auto}\n.tag{display:inline-block;padding:.12rem .5rem;border-radius:4px;font-size:.72rem;font-weight:600;margin-right:.25rem;white-space:nowrap}\n.tag-g{background:var(--tag-g);color:var(--tag-g-t)}.tag-b{background:var(--tag-b);color:var(--tag-b-t)}\n.tag-r{background:var(--tag-r);color:var(--tag-r-t)}.tag-y{background:var(--tag-y);color:var(--tag-y-t)}.tag-p{background:var(--tag-p);color:var(--tag-p-t)}\n.card{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:1.25rem;margin-bottom:1rem;box-shadow:var(--shadow)}\n.info-box{background:var(--bg);border-left:4px solid var(--accent);padding:.9rem 1.1rem;margin:1rem 0;border-radius:0 var(--radius) var(--radius) 0;font-size:.88rem}\n.info-box strong{color:var(--accent)}\n.info-box.warn{border-left-color:var(--accent4)}.info-box.warn strong{color:var(--accent4)}\n.info-box.danger{border-left-color:var(--accent3)}.info-box.danger strong{color:var(--accent3)}\n.toc{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:1.15rem 1.4rem;margin-bottom:2rem;box-shadow:var(--shadow)}\n.toc h3{margin:0 0 .5rem;font-size:.9rem;color:var(--muted);text-transform:uppercase;letter-spacing:.05em}\n.toc ol{padding-left:1.1rem;columns:2;column-gap:2rem}\n.toc li{margin-bottom:.25rem;font-size:.88rem}.toc a{color:var(--ink)}.toc a:hover{color:var(--accent);text-decoration:none}\npre.code-block{background:var(--code-bg);padding:.85rem 1rem;border-radius:var(--radius);overflow-x:auto;font-family:\"SF Mono\",Consolas,\"Courier New\",monospace;font-size:.82rem;line-height:1.5;margin:.6rem 0;border:1px solid var(--rule)}\ncode,.inline-code{background:var(--code-bg);padding:.12rem .4rem;border-radius:4px;font-family:\"SF Mono\",Consolas,\"Courier New\",monospace;font-size:.83rem;border:1px solid var(--rule)}\n.table-wrap{overflow-x:auto;margin:1.2rem 0}\ntable{width:100%;border-collapse:collapse;font-size:.82rem}\nthead th{background:var(--accent);color:#fff;padding:.6rem .5rem;text-align:center;font-weight:600;white-space:nowrap}\nthead th:first-child{border-radius:6px 0 0 0}thead th:last-child{border-radius:0 6px 0 0}\ntbody td{padding:.55rem .5rem;border-bottom:1px solid var(--rule);text-align:center;vertical-align:middle}\ntbody tr:nth-child(even){background:var(--bg)}\ntbody td:first-child{text-align:left;font-weight:600}\n.terminal{background:#1a1a2e;color:#a8e6cf;border-radius:var(--radius);padding:.9rem 1rem;font-family:\"SF Mono\",Consolas,\"Courier New\",monospace;font-size:.82rem;line-height:1.6;margin:.6rem 0;overflow-x:auto;border:1px solid #333}\n.terminal .prompt{color:#60a5fa}.terminal .comment{color:#6c7086;font-style:italic}.terminal .output{color:#e2e4f0}\n[data-theme=\"dark\"] .terminal{background:#08081a}\n.steps{counter-reset:step;list-style:none;padding:0}\n.steps li{counter-increment:step;position:relative;padding:.85rem 1rem .85rem 2.8rem;margin-bottom:.5rem;border-left:2px solid var(--rule);border-radius:0 var(--radius) 0;background:var(--card-bg);box-shadow:var(--shadow)}\n.steps li::before{content:counter(step);position:absolute;left:-13px;top:.85rem;width:26px;height:26px;border-radius:50%;background:var(--accent);color:#fff;display:flex;align-items:center;justify-content:center;font-size:.78rem;font-weight:700}\n.steps li .cmd{display:block;background:var(--code-bg);padding:.4rem .7rem;border-radius:5px;font-family:\"SF Mono\",Consolas,\"Courier New\",monospace;font-size:.82rem;margin:.3rem 0;overflow-x:auto;border:1px solid var(--rule)}\n.steps li .note{display:block;color:var(--muted);font-size:.82rem;margin-top:.2rem}\n.flow-diagram{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:1.25rem;margin:1.25rem 0;text-align:center}\n.flow-row{display:flex;align-items:center;justify-content:center;flex-wrap:wrap;gap:.35rem;margin:.4rem 0}\n.flow-item{display:inline-block;padding:.4rem .8rem;border-radius:6px;font-weight:600;font-size:.82rem;text-align:center;background:var(--accent);color:#fff;min-width:60px}\n.flow-item.green{background:var(--accent2)}.flow-item.red{background:var(--accent3)}.flow-item.yellow{background:var(--accent4);color:#1a1a2e}.flow-item.purple{background:var(--accent5)}\n.flow-arrow{color:var(--muted);font-size:1rem}\n.cmd-grid{display:grid;grid-template-columns:repeat(auto-fill,minmax(280px,1fr));gap:.75rem;margin:1rem 0}\n.cmd-card{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:.9rem;box-shadow:var(--shadow)}\n.cmd-card h4{margin:0 0 .35rem;font-size:.88rem;color:var(--accent)}\n.cmd-card .cmd{font-family:\"SF Mono\",Consolas,\"Courier New\",monospace;font-size:.8rem;background:var(--code-bg);padding:.3rem .5rem;border-radius:4px;display:block;margin-bottom:.3rem;border:1px solid var(--rule)}\n.cmd-card .desc{font-size:.8rem;color:var(--muted)}\n.two-col{display:grid;grid-template-columns:1fr 1fr;gap:1.25rem;margin:1.25rem 0}\n.col{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:1.25rem;box-shadow:var(--shadow)}\n.col h4{margin-top:0}\n.compare-box{display:grid;grid-template-columns:1fr 1fr;gap:1rem;margin:1rem 0}\n.compare-col{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:1rem;box-shadow:var(--shadow)}\n.compare-col h4{margin:0 0 .4rem;font-size:.88rem}\n.compare-col.bad h4{color:var(--accent3)}\n.compare-col.good h4{color:var(--accent2)}\npre.example{background:var(--code-bg);padding:.6rem .8rem;border-radius:6px;font-family:\"SF Mono\",Consolas,\"Courier New\",monospace;font-size:.78rem;line-height:1.5;margin:.4rem 0;border:1px solid var(--rule);color:var(--ink)}\n.screenshot{background:var(--card-bg);border:1px solid var(--rule);border-radius:var(--radius);padding:1rem;margin:1rem 0;text-align:center;box-shadow:var(--shadow)}\n.screenshot .label{font-size:.82rem;color:var(--muted);margin-bottom:.5rem}\n.screenshot .mock{background:var(--bg);border:2px dashed var(--rule);border-radius:var(--radius);padding:2rem 1rem;color:var(--muted);font-size:.85rem;line-height:1.6}\n.screenshot .mock .mock-header{background:var(--bg2);border:1px solid var(--rule);border-radius:6px;padding:.6rem 1rem;margin-bottom:.8rem;text-align:left;font-weight:600;font-size:.82rem;color:var(--ink);display:flex;align-items:center;gap:.5rem}\n.screenshot .mock .mock-header .tab{background:var(--accent);color:#fff;padding:.15rem .6rem;border-radius:4px;font-size:.75rem;font-weight:600}\n.screenshot .mock .mock-sidebar{display:inline-block;width:160px;vertical-align:top;text-align:left;padding:.5rem;border-right:1px solid var(--rule);margin-right:1rem;font-size:.78rem;line-height:1.8}\n.screenshot .mock .mock-content{display:inline-block;width:calc(100% - 200px);vertical-align:top;text-align:left;font-size:.8rem;line-height:1.7}\n.screenshot .mock .mock-sidebar .active{color:var(--accent);font-weight:600}\nfooter{max-width:var(--max-w);margin:3rem auto 0;padding:2rem 1.5rem 3rem;border-top:1px solid var(--rule);text-align:center;font-size:.82rem;color:var(--muted)}\nfooter .links{display:flex;justify-content:center;gap:1.5rem;flex-wrap:wrap;margin-bottom:.8rem}\nfooter .links a{color:var(--muted)}footer .links a:hover{color:var(--accent)}\n@media(max-width:640px){\n h1{font-size:1.4rem}.toc ol{columns:1}.header-inner{padding:0 1rem}main{padding:72px 1rem 2rem}\n .steps li{padding-left:2.4rem}.steps li::before{left:-11px;width:22px;height:22px;font-size:.7rem}\n .two-col{grid-template-columns:1fr}.cmd-grid{grid-template-columns:1fr}.compare-box{grid-template-columns:1fr}\n .screenshot .mock .mock-sidebar{display:block;width:100%;border-right:none;border-bottom:1px solid var(--rule);margin-bottom:.5rem;margin-right:0}\n .screenshot .mock .mock-content{display:block;width:100%}\n}\n<\/style>\n<\/head>\n<body>\n<header>\n <div class=\"header-inner\">\n <div class=\"logo\"><span>📚<\/span> Repo Wiki \u5b8c\u6574\u6307\u5357<\/div>\n <div class=\"controls\">\n <div class=\"lang-switch\">\n <button class=\"active\" onclick=\"setLang('zh')\" id=\"btn-zh\">\u4e2d\u6587<\/button>\n <button onclick=\"setLang('en')\" id=\"btn-en\">English<\/button>\n <\/div>\n <button class=\"theme-toggle\" onclick=\"toggleTheme()\" title=\"\u5207\u6362\u660e\u6697\u4e3b\u9898\">☼<\/button>\n <\/div>\n <\/div>\n<\/header>\n<main>\n<!-- ======== \u4e2d\u6587\u7248 ======== -->\n<div class=\"lang-section active\" id=\"lang-zh\">\n<div class=\"hero\">\n <h1>\u4ee3\u7801\u4ed3\u5e93 Wiki \u5b8c\u6574\u4f7f\u7528\u6307\u5357<span class=\"sub\">GitHub \/ GitLab Wiki \u4ece\u542f\u7528\u5230\u9ad8\u6548\u534f\u4f5c\u5168\u6d41\u7a0b<\/span><\/h1>\n <p>\u4ec0\u4e48\u662f Repo Wiki\u3001\u4e0e README \u548c docs \u76ee\u5f55\u7684\u533a\u522b\u3001\u521b\u5efa\u4e0e\u7f16\u8f91\u9875\u9762\u3001\u4fa7\u8fb9\u680f\u5bfc\u822a\u7ec4\u7ec7\u3001\u672c\u5730 Git \u514b\u9686\u7f16\u8f91\u3001\u5f00\u6e90\u9879\u76ee Wiki \u534f\u4f5c\u89c4\u8303\u3001\u6700\u4f73\u5b9e\u8df5\u4e0e\u5e38\u89c1\u95ee\u9898<\/p>\n<\/div>\n\n<div class=\"toc\">\n <h3>\u76ee\u5f55<\/h3>\n <ol>\n <li><a href=\"#zh-1\">\u4e00\u3001\u4ec0\u4e48\u662f Repo Wiki\uff0c\u89e3\u51b3\u4ec0\u4e48\u95ee\u9898<\/a><\/li>\n <li><a href=\"#zh-2\">\u4e8c\u3001Wiki vs README vs docs \u76ee\u5f55\u5bf9\u6bd4<\/a><\/li>\n <li><a href=\"#zh-3\">\u4e09\u3001GitHub Wiki \u542f\u7528\u4e0e\u57fa\u7840\u64cd\u4f5c<\/a><\/li>\n <li><a href=\"#zh-4\">\u56db\u3001Wiki \u9875\u9762\u521b\u5efa\u4e0e Markdown \u7f16\u5199<\/a><\/li>\n <li><a href=\"#zh-5\">\u4e94\u3001\u4fa7\u8fb9\u680f\u5bfc\u822a\u4e0e\u9875\u9762\u7ec4\u7ec7<\/a><\/li>\n <li><a href=\"#zh-6\">\u516d\u3001Wiki \u672c\u5730 Git \u514b\u9686\u7f16\u8f91\u5de5\u4f5c\u6d41<\/a><\/li>\n <li><a href=\"#zh-7\">\u4e03\u3001GitLab Wiki \u7279\u6027\u4e0e\u5dee\u5f02<\/a><\/li>\n <li><a href=\"#zh-8\">\u516b\u3001\u5f00\u6e90\u9879\u76ee Wiki \u534f\u4f5c\u89c4\u8303<\/a><\/li>\n <li><a href=\"#zh-9\">\u4e5d\u3001Wiki \u6700\u4f73\u5b9e\u8df5\u4e0e\u7ec4\u7ec7\u6a21\u677f<\/a><\/li>\n <li><a href=\"#zh-10\">\u5341\u3001\u5e38\u89c1\u95ee\u9898\u4e0e\u89e3\u51b3\u65b9\u6848<\/a><\/li>\n <\/ol>\n<\/div>\n\n<!-- \u4e00\u3001\u4ec0\u4e48\u662f Repo Wiki -->\n<h2 id=\"zh-1\">\u4e00\u3001\u4ec0\u4e48\u662f Repo Wiki\uff0c\u89e3\u51b3\u4ec0\u4e48\u6838\u5fc3\u95ee\u9898<\/h2>\n<p>Repo Wiki\uff08\u4ed3\u5e93 Wiki\uff09\u662f GitHub \/ GitLab \u5185\u7f6e\u7684\u8f7b\u91cf\u7ea7\u6587\u6863\u7cfb\u7edf\uff0c\u76f4\u63a5\u6302\u8f7d\u5728\u4ee3\u7801\u4ed3\u5e93\u4e4b\u4e0b\uff0c\u4e13\u4e3a\u9879\u76ee\u63d0\u4f9b<strong>\u7ed3\u6784\u5316\u7684\u5728\u7ebf\u6587\u6863<\/strong>\u7a7a\u95f4\u3002<\/p>\n\n<div class=\"screenshot\">\n <div class=\"label\">Wiki \u5728\u4ed3\u5e93\u4e2d\u7684\u4f4d\u7f6e<\/div>\n <div class=\"mock\">\n <div class=\"mock-header\"><span class=\"tab\">Code<\/span><span class=\"tab\">Issues<\/span><span class=\"tab\">Pull requests<\/span><span class=\"tab\">Actions<\/span><span class=\"tab\" style=\"background:var(--accent2)\">Wiki<\/span><span class=\"tab\">Settings<\/span><\/div>\n <div class=\"mock-sidebar\">\n <div class=\"active\">Home<\/div>\n <div>Getting Started<\/div>\n <div>Architecture<\/div>\n <div>API Reference<\/div>\n <div>Deployment<\/div>\n <div>FAQ<\/div>\n <div>Changelog<\/div>\n <\/div>\n <div class=\"mock-content\">\n <strong>ProjectName Wiki<\/strong><br>\n Welcome to the ProjectName wiki! This space contains comprehensive documentation for the project, including setup guides, architecture overviews, and API references.\n <\/div>\n <\/div>\n<\/div>\n\n<div class=\"info-box\">\n <strong>\u6838\u5fc3\u5b9a\u4f4d\uff1aWiki \u662f\u4ee3\u7801\u4ed3\u5e93\u7684”\u77e5\u8bc6\u5e93”\uff0c\u627f\u8f7d\u9879\u76ee\u8bf4\u660e\u6587\u6863\u3001\u4f7f\u7528\u6559\u7a0b\u3001\u8bbe\u8ba1\u51b3\u7b56\u3001FAQ \u7b49\u4e2d\u957f\u671f\u5185\u5bb9\uff0c\u4e0e\u4ee3\u7801\u540c\u4ed3\u5e93\u7ba1\u7406\u3001\u540c\u6743\u9650\u63a7\u5236\u3002<\/strong>\n<\/div>\n\n<div class=\"card\">\n <h4>Wiki \u56db\u5927\u6838\u5fc3\u4ef7\u503c<\/h4>\n <p><span class=\"tag tag-b\">\u96f6\u914d\u7f6e<\/span> \u4ed3\u5e93\u5185\u7f6e\u529f\u80fd\uff0c\u65e0\u9700\u989d\u5916\u90e8\u7f72\u6587\u6863\u7ad9\u70b9\u6216\u914d\u7f6e\u6784\u5efa\u5de5\u5177<\/p>\n <p><span class=\"tag tag-g\">\u6743\u9650\u590d\u7528<\/span> \u81ea\u52a8\u7ee7\u627f\u4ed3\u5e93\u7684 Collaborator \u6743\u9650\uff0c\u56e2\u961f\u6210\u5458\u76f4\u63a5\u53ef\u7f16\u8f91<\/p>\n <p><span class=\"tag tag-y\">\u7248\u672c\u7ba1\u7406<\/span> \u6bcf\u6b21\u7f16\u8f91\u81ea\u52a8\u4fdd\u5b58\u5386\u53f2\u7248\u672c\uff0c\u652f\u6301\u56de\u6eda\u548c\u5dee\u5f02\u5bf9\u6bd4<\/p>\n <p><span class=\"tag tag-p\">\u72ec\u7acb\u4e8e\u4ee3\u7801<\/span> \u6587\u6863\u53d8\u66f4\u4e0d\u4f1a\u4ea7\u751f\u4ee3\u7801 Commit \u566a\u97f3\uff0c\u4fdd\u6301 Git \u63d0\u4ea4\u8bb0\u5f55\u6574\u6d01<\/p>\n<\/div>\n\n<!-- \u4e8c\u3001Wiki vs README vs docs -->\n<h2 id=\"zh-2\">\u4e8c\u3001Wiki vs README vs docs \u76ee\u5f55\u5bf9\u6bd4<\/h2>\n<p>\u9879\u76ee\u4e2d\u5e38\u89c1\u7684\u6587\u6863\u5b58\u653e\u4f4d\u7f6e\u6709\u4e09\u79cd\uff0c\u9002\u7528\u573a\u666f\u5404\u4e0d\u76f8\u540c\uff1a<\/p>\n\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>\u7ef4\u5ea6<\/th><th>README.md<\/th><th>docs\/ \u76ee\u5f55<\/th><th>Repo Wiki<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr>\n <td>\u4f4d\u7f6e<\/td>\n <td>\u4ed3\u5e93\u6839\u76ee\u5f55<\/td>\n <td>\u4ed3\u5e93\u5185\u7684 docs\/ \u6587\u4ef6\u5939<\/td>\n <td>\u4ed3\u5e93\u7684 Wiki \u6807\u7b7e\u9875<\/td>\n <\/tr>\n <tr>\n <td>\u7248\u672c\u63a7\u5236<\/td>\n <td>Git \u8ddf\u8e2a<\/td>\n <td>Git \u8ddf\u8e2a<\/td>\n <td>\u72ec\u7acb Git \u4ed3\u5e93\uff08\u81ea\u52a8\u7ba1\u7406\uff09<\/td>\n <\/tr>\n <tr>\n <td>\u53ef\u89c1\u6027<\/td>\n <td>\u4ed3\u5e93\u9996\u9875\u76f4\u63a5\u5c55\u793a<\/td>\n <td>\u9700\u8fdb\u5165\u76ee\u5f55\u6d4f\u89c8<\/td>\n <td>\u72ec\u7acb Wiki \u9875\u9762\u6d4f\u89c8<\/td>\n <\/tr>\n <tr>\n <td>\u9002\u5408\u5185\u5bb9<\/td>\n <td>\u9879\u76ee\u7b80\u4ecb\u3001\u5feb\u901f\u5f00\u59cb\u3001\u5b89\u88c5\u547d\u4ee4<\/td>\n <td>API \u6587\u6863\u3001\u8be6\u7ec6\u6307\u5357\uff08\u914d\u5408 MkDocs \u7b49\uff09<\/td>\n <td>\u4f7f\u7528\u6559\u7a0b\u3001FAQ\u3001\u8bbe\u8ba1\u6587\u6863\u3001\u4f1a\u8bae\u8bb0\u5f55<\/td>\n <\/tr>\n <tr>\n <td>\u7f16\u8f91\u95e8\u69db<\/td>\n <td>\u9700 Fork + PR<\/td>\n <td>\u9700 Fork + PR<\/td>\n <td>\u6709\u6743\u9650\u5373\u53ef\u7f51\u9875\u76f4\u63a5\u7f16\u8f91<\/td>\n <\/tr>\n <tr>\n <td>\u591a\u9875\u9762<\/td>\n <td>\u5355\u6587\u4ef6<\/td>\n <td>\u652f\u6301\u591a\u6587\u4ef6<\/td>\n <td>\u5929\u7136\u591a\u9875\u9762 + \u5bfc\u822a<\/td>\n <\/tr>\n <tr>\n <td>\u641c\u7d22<\/td>\n <td>\u4ed3\u5e93\u5168\u5c40\u641c\u7d22<\/td>\n <td>\u4ed3\u5e93\u5168\u5c40\u641c\u7d22<\/td>\n <td>Wiki \u5185\u7f6e\u641c\u7d22<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<div class=\"compare-box\">\n <div class=\"compare-col good\">\n <h4>\u63a8\u8350\u7ec4\u5408\u7b56\u7565<\/h4>\n <p>README\uff1a\u9879\u76ee\u540d\u7247\uff0c\u4e00\u53e5\u8bdd\u8bf4\u660e + \u5feb\u901f\u5f00\u59cb<\/p>\n <p>docs\/\uff1a\u9700\u8981\u7248\u672c\u5316\u8ddf\u8e2a\u7684\u6b63\u5f0f API \u6587\u6863<\/p>\n <p>Wiki\uff1a\u52a8\u6001\u77e5\u8bc6\u5e93\uff0c\u6559\u7a0b\u3001FAQ\u3001\u8bbe\u8ba1\u8ba8\u8bba<\/p>\n <\/div>\n <div class=\"compare-col bad\">\n <h4>\u5e38\u89c1\u8bef\u533a<\/h4>\n <p>\u628a\u6240\u6709\u6587\u6863\u585e\u8fdb README \u5bfc\u81f4\u6587\u4ef6\u8fc7\u957f<\/p>\n <p>Wiki \u548c docs\/ \u5b58\u653e\u76f8\u540c\u5185\u5bb9\u9020\u6210\u7ef4\u62a4\u5206\u88c2<\/p>\n <p>\u4ece\u4e0d\u4f7f\u7528 Wiki\uff0c\u91cd\u8981\u8ba8\u8bba\u6563\u843d\u5728 Issue \u4e2d<\/p>\n <\/div>\n<\/div>\n\n<!-- \u4e09\u3001GitHub Wiki \u542f\u7528\u4e0e\u57fa\u7840\u64cd\u4f5c -->\n<h2 id=\"zh-3\">\u4e09\u3001GitHub Wiki \u542f\u7528\u4e0e\u57fa\u7840\u64cd\u4f5c<\/h2>\n\n<h3>3.1 \u542f\u7528 Wiki<\/h3>\n<ol class=\"steps\">\n <li>\u6253\u5f00\u76ee\u6807\u4ed3\u5e93\u9875\u9762\uff0c\u70b9\u51fb\u9876\u90e8\u6807\u7b7e\u680f\u7684 <code>Wiki<\/code><\/li>\n <li>\u5982\u679c\u662f\u9996\u6b21\u8bbf\u95ee\uff0cGitHub \u4f1a\u63d0\u793a <strong>“Create the first page”<\/strong>\uff0c\u70b9\u51fb\u6309\u94ae\u5373\u53ef\u542f\u7528<\/li>\n <li>\u9996\u9875\u9ed8\u8ba4\u6587\u4ef6\u540d\u4e3a <code>Home.md<\/code>\uff0c\u4f5c\u4e3a Wiki \u7684\u5165\u53e3\u9875\u9762<\/li>\n <li>\u5982\u679c\u4ed3\u5e93 Settings \u4e2d Wiki \u88ab\u7981\u7528\uff0c\u9700\u7531\u7ba1\u7406\u5458\u524d\u5f80 <strong>Settings \u2192 Features \u2192 Wikis<\/strong> \u52fe\u9009\u542f\u7528<\/li>\n<\/ol>\n\n<div class=\"info-box warn\">\n <strong>\u6ce8\u610f\uff1aWiki \u542f\u7528\u540e\u53ef\u5728\u4ed3\u5e93 Settings \u4e2d\u968f\u65f6\u5173\u95ed\u3002\u5173\u95ed\u540e\u5185\u5bb9\u4e0d\u4f1a\u88ab\u5220\u9664\uff0c\u91cd\u65b0\u542f\u7528\u540e\u53ef\u6062\u590d\u3002<\/strong>\n<\/div>\n\n<h3>3.2 \u57fa\u7840\u9875\u9762\u64cd\u4f5c<\/h3>\n<div class=\"cmd-grid\">\n <div class=\"cmd-card\">\n <h4>\u65b0\u5efa\u9875\u9762<\/h4>\n <div class=\"cmd\">Wiki \u53f3\u4fa7 \u2192 New Page<\/div>\n <div class=\"desc\">\u8f93\u5165\u9875\u9762\u6807\u9898\uff0c\u81ea\u52a8\u751f\u6210 .md \u6587\u4ef6\u540d<\/div>\n <\/div>\n <div class=\"cmd-card\">\n <h4>\u7f16\u8f91\u9875\u9762<\/h4>\n <div class=\"cmd\">\u6253\u5f00\u9875\u9762 \u2192 \u53f3\u4e0a\u89d2 Edit<\/div>\n <div class=\"desc\">\u652f\u6301 Markdown \u7f16\u8f91\u5668\uff0c\u53ef\u5207\u6362\u9884\u89c8\u6a21\u5f0f<\/div>\n <\/div>\n <div class=\"cmd-card\">\n <h4>\u67e5\u770b\u5386\u53f2<\/h4>\n <div class=\"cmd\">\u9875\u9762\u53f3\u4e0a\u89d2 \u2192 Page History<\/div>\n <div class=\"desc\">\u67e5\u770b\u6240\u6709\u4fee\u8ba2\u7248\u672c\uff0c\u652f\u6301\u5dee\u5f02\u5bf9\u6bd4\u548c\u56de\u6eda<\/div>\n <\/div>\n <div class=\"cmd-card\">\n <h4>\u5220\u9664\u9875\u9762<\/h4>\n <div class=\"cmd\">\u9875\u9762\u5185 \u2192 Tools \u2192 Delete page<\/div>\n <div class=\"desc\">\u5220\u9664\u540e\u53ef\u5728\u5386\u53f2\u7248\u672c\u4e2d\u6062\u590d<\/div>\n <\/div>\n<\/div>\n\n<!-- \u56db\u3001Wiki \u9875\u9762\u521b\u5efa\u4e0e Markdown -->\n<h2 id=\"zh-4\">\u56db\u3001Wiki \u9875\u9762\u521b\u5efa\u4e0e Markdown \u7f16\u5199<\/h2>\n\n<h3>4.1 \u652f\u6301\u7684\u683c\u5f0f<\/h3>\n<p>GitHub Wiki \u652f\u6301\u591a\u79cd\u6807\u8bb0\u8bed\u8a00\uff0c\u901a\u8fc7\u6587\u4ef6\u6269\u5c55\u540d\u6307\u5b9a\uff1a<\/p>\n\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>\u683c\u5f0f<\/th><th>\u6269\u5c55\u540d<\/th><th>\u8bf4\u660e<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>Markdown<\/td><td>.md<\/td><td>\u63a8\u8350\uff0cGitHub \u539f\u751f\u652f\u6301\uff0c\u6e32\u67d3\u6548\u679c\u6700\u597d<\/td><\/tr>\n <tr><td>AsciiDoc<\/td><td>.adoc<\/td><td>\u9002\u5408\u6280\u672f\u6587\u6863\uff0c\u652f\u6301\u66f4\u590d\u6742\u7684\u7ed3\u6784<\/td><\/tr>\n <tr><td>reStructuredText<\/td><td>.rst<\/td><td>Python \u793e\u533a\u5e38\u7528\u683c\u5f0f<\/td><\/tr>\n <tr><td>Org Mode<\/td><td>.org<\/td><td>Emacs \u751f\u6001\u6807\u8bb0\u8bed\u8a00<\/td><\/tr>\n <tr><td>MediaWiki<\/td><td>.mediawiki<\/td><td>\u4f20\u7edf Wiki \u6807\u8bb0\u8bed\u6cd5<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<div class=\"info-box\">\n <strong>\u5f3a\u70c8\u5efa\u8bae\u7edf\u4e00\u4f7f\u7528 Markdown (.md)\uff0c\u4e0e GitHub \u751f\u6001\u4e00\u81f4\uff0c\u56e2\u961f\u5b66\u4e60\u6210\u672c\u6700\u4f4e\uff0c\u6e32\u67d3\u548c\u534f\u4f5c\u4f53\u9a8c\u6700\u4f73\u3002<\/strong>\n<\/div>\n\n<h3>4.2 Wiki \u5185\u94fe\u4e0e\u8d44\u6e90\u5f15\u7528<\/h3>\n<pre class=\"code-block\"># Wiki \u9875\u9762\u5185\u90e8\u94fe\u63a5\uff08\u4f7f\u7528\u6587\u4ef6\u540d\uff0c\u4e0d\u542b\u6269\u5c55\u540d\uff09\n[[Getting-Started]]\n[[API-Reference|API \u53c2\u8003\u6587\u6863]] <!-- \u5e26\u81ea\u5b9a\u4e49\u663e\u793a\u6587\u672c -->\n\n# \u5f15\u7528 Wiki \u4e2d\u7684\u56fe\u7247\uff08\u56fe\u7247\u9700\u4e0a\u4f20\u5230 Wiki\uff09\n\n\n# \u5f15\u7528\u4ed3\u5e93\u4e2d\u7684\u6587\u4ef6\n[\u67e5\u770b\u6e90\u7801](https:\/\/github.com\/user\/repo\/blob\/main\/src\/main.py)\n<\/pre>\n\n<h3>4.3 Wiki \u9875\u9762\u5143\u6570\u636e\uff08YAML Front Matter\uff09<\/h3>\n<p>\u867d\u7136 GitHub Wiki \u4e0d\u5f3a\u5236\u8981\u6c42 Front Matter\uff0c\u4f46\u914d\u5408\u81ea\u5b9a\u4e49\u5de5\u5177\u65f6\u53ef\u7528\u4e8e\u5206\u7c7b\u548c\u6392\u5e8f\uff1a<\/p>\n<pre class=\"code-block\">---\ntitle: \u5feb\u901f\u5f00\u59cb\ncategory: getting-started\norder: 1\nupdated: 2026-07-15\n---\n\n# \u5feb\u901f\u5f00\u59cb\n\n\u672c\u6587\u6863\u4ecb\u7ecd\u5982\u4f55\u5b89\u88c5\u548c\u8fd0\u884c\u9879\u76ee...\n<\/pre>\n\n<!-- \u4e94\u3001\u4fa7\u8fb9\u680f\u5bfc\u822a -->\n<h2 id=\"zh-5\">\u4e94\u3001\u4fa7\u8fb9\u680f\u5bfc\u822a\u4e0e\u9875\u9762\u7ec4\u7ec7<\/h2>\n\n<h3>5.1 \u81ea\u52a8\u4fa7\u8fb9\u680f<\/h3>\n<p>GitHub Wiki \u4f1a\u81ea\u52a8\u6839\u636e <code>_Sidebar.md<\/code> \u6587\u4ef6\u751f\u6210\u5de6\u4fa7\u5bfc\u822a\u680f\u3002\u82e5\u672a\u521b\u5efa\u8be5\u6587\u4ef6\uff0c\u4fa7\u8fb9\u680f\u9ed8\u8ba4\u6309\u5b57\u6bcd\u987a\u5e8f\u5217\u51fa\u6240\u6709\u9875\u9762\u3002<\/p>\n\n<h3>5.2 \u81ea\u5b9a\u4e49 _Sidebar.md<\/h3>\n<pre class=\"code-block\"># _Sidebar.md\uff08Wiki \u4e2d\u7684\u7279\u6b8a\u6587\u4ef6\u540d\uff09\n\n## \u5feb\u901f\u5bfc\u822a\n\n- [[Home|\u9996\u9875]]\n- [[Getting-Started|\u5feb\u901f\u5f00\u59cb]]\n- [[Installation|\u5b89\u88c5\u6307\u5357]]\n\n## \u4f7f\u7528\u6587\u6863\n\n- [[Configuration|\u914d\u7f6e\u8bf4\u660e]]\n- [[API-Reference|API \u53c2\u8003]]\n- [[Plugins|\u63d2\u4ef6\u5f00\u53d1]]\n\n## \u8fdb\u9636\u5185\u5bb9\n\n- [[Architecture|\u7cfb\u7edf\u67b6\u6784]]\n- [[Design-Notes|\u8bbe\u8ba1\u51b3\u7b56]]\n- [[Performance|\u6027\u80fd\u4f18\u5316]]\n\n## \u793e\u533a\n\n- [[Contributing|\u8d21\u732e\u6307\u5357]]\n- [[Changelog|\u66f4\u65b0\u65e5\u5fd7]]\n- [[FAQ|\u5e38\u89c1\u95ee\u9898]]\n<\/pre>\n\n<div class=\"screenshot\">\n <div class=\"label\">\u81ea\u5b9a\u4e49\u4fa7\u8fb9\u680f\u6548\u679c<\/div>\n <div class=\"mock\">\n <div class=\"mock-header\"><span class=\"tab\">Code<\/span><span class=\"tab\">Issues<\/span><span class=\"tab\">Wiki<\/span><\/div>\n <div class=\"mock-sidebar\">\n <div style=\"color:var(--muted);font-size:.7rem;font-weight:600;text-transform:uppercase\">\u5feb\u901f\u5bfc\u822a<\/div>\n <div class=\"active\">\u9996\u9875<\/div>\n <div>\u5feb\u901f\u5f00\u59cb<\/div>\n <div>\u5b89\u88c5\u6307\u5357<\/div>\n <div style=\"color:var(--muted);font-size:.7rem;font-weight:600;text-transform:uppercase;margin-top:.4rem\">\u4f7f\u7528\u6587\u6863<\/div>\n <div>\u914d\u7f6e\u8bf4\u660e<\/div>\n <div>API \u53c2\u8003<\/div>\n <div>\u63d2\u4ef6\u5f00\u53d1<\/div>\n <div style=\"color:var(--muted);font-size:.7rem;font-weight:600;text-transform:uppercase;margin-top:.4rem\">\u793e\u533a<\/div>\n <div>\u8d21\u732e\u6307\u5357<\/div>\n <div>FAQ<\/div>\n <\/div>\n <div class=\"mock-content\">\n <strong>\u5feb\u901f\u5f00\u59cb<\/strong><br><br>\n \u672c\u6587\u6863\u5e2e\u52a9\u4f60\u5728 5 \u5206\u949f\u5185\u5b8c\u6210\u9879\u76ee\u5b89\u88c5\u548c\u9996\u6b21\u8fd0\u884c…\n <\/div>\n <\/div>\n<\/div>\n\n<h3>5.3 \u5176\u4ed6\u7279\u6b8a\u9875\u9762<\/h3>\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>\u7279\u6b8a\u6587\u4ef6\u540d<\/th><th>\u4f5c\u7528<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>_Sidebar.md<\/td><td>\u81ea\u5b9a\u4e49\u5de6\u4fa7\u5bfc\u822a\u680f\u5185\u5bb9<\/td><\/tr>\n <tr><td>_Footer.md<\/td><td>\u81ea\u5b9a\u4e49\u9875\u9762\u5e95\u90e8\u5185\u5bb9<\/td><\/tr>\n <tr><td>Home.md<\/td><td>Wiki \u9ed8\u8ba4\u9996\u9875<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<!-- \u516d\u3001Wiki \u672c\u5730 Git \u514b\u9686 -->\n<h2 id=\"zh-6\">\u516d\u3001Wiki \u672c\u5730 Git \u514b\u9686\u7f16\u8f91\u5de5\u4f5c\u6d41<\/h2>\n\n<div class=\"info-box\">\n <strong>GitHub Wiki \u672c\u8d28\u4e0a\u662f\u4e00\u4e2a\u72ec\u7acb\u7684 Git \u4ed3\u5e93\uff0c\u53ef\u4ee5\u514b\u9686\u5230\u672c\u5730\u4f7f\u7528\u4efb\u610f\u7f16\u8f91\u5668\u6279\u91cf\u7f16\u8f91\uff0c\u518d\u63a8\u9001\u56de\u8fdc\u7a0b\u3002<\/strong>\n<\/div>\n\n<h3>6.1 \u514b\u9686 Wiki \u4ed3\u5e93<\/h3>\n<pre class=\"terminal\"><span class=\"comment\"># Wiki \u4ed3\u5e93\u5730\u5740 = \u4e3b\u4ed3\u5e93\u5730\u5740 + .wiki.git<\/span>\n<span class=\"prompt\">git clone<\/span> https:\/\/github.com\/user\/repo.wiki.git\n<span class=\"prompt\">cd<\/span> repo.wiki\n<span class=\"prompt\">ls<\/span>\n<span class=\"output\">Home.md _Sidebar.md Getting-Started.md API-Reference.md<\/span>\n<\/pre>\n\n<h3>6.2 \u672c\u5730\u7f16\u8f91\u540e\u63a8\u9001<\/h3>\n<ol class=\"steps\">\n <li>\u7528 VS Code \u6216\u4efb\u610f\u7f16\u8f91\u5668\u6253\u5f00 Wiki \u4ed3\u5e93\u76ee\u5f55<\/li>\n <li>\u7f16\u8f91\u6216\u65b0\u5efa .md \u6587\u4ef6\uff0c\u4f7f\u7528\u672c\u5730 Git \u8fdb\u884c\u7248\u672c\u7ba1\u7406<\/li>\n <li class=\"note\">\u672c\u5730\u7f16\u8f91\u53ef\u4f7f\u7528 Git \u5206\u652f\u3001diff \u7b49\u5b8c\u6574\u5de5\u5177\u94fe\uff0c\u6bd4\u7f51\u9875\u7f16\u8f91\u9ad8\u6548\u5f97\u591a<\/li>\n <li>\u5b8c\u6210\u540e\u63a8\u9001\u56de\u8fdc\u7a0b Wiki \u4ed3\u5e93<\/li>\n<\/ol>\n\n<pre class=\"terminal\"><span class=\"prompt\">git add .<\/span>\n<span class=\"prompt\">git commit -m<\/span> \"docs: \u6dfb\u52a0 API \u53c2\u8003\u6587\u6863\u548c\u914d\u7f6e\u8bf4\u660e\"\n<span class=\"prompt\">git push origin master<\/span>\n<\/pre>\n\n<div class=\"flow-diagram\">\n <div class=\"flow-row\">\n <span class=\"flow-item green\">\u514b\u9686 Wiki<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item\">\u672c\u5730\u7f16\u8f91<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item\">Git Commit<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item yellow\">Push \u8fdc\u7a0b<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item purple\">Wiki \u66f4\u65b0<\/span>\n <\/div>\n<\/div>\n\n<h3>6.3 SSH \u514b\u9686<\/h3>\n<pre class=\"terminal\"><span class=\"comment\"># \u5982\u679c\u4e3b\u4ed3\u5e93\u4f7f\u7528 SSH\uff0cWiki \u540c\u6837\u652f\u6301<\/span>\n<span class=\"prompt\">git clone<\/span> git@github.com:user\/repo.wiki.git\n<\/pre>\n\n<div class=\"info-box warn\">\n <strong>Wiki \u4ed3\u5e93\u9ed8\u8ba4\u5206\u652f\u4e3a master\uff08\u975e main\uff09\uff0c\u514b\u9686\u540e\u8bf7\u786e\u8ba4\u5f53\u524d\u5206\u652f\u3002Wiki \u4ed3\u5e93\u4e0e\u4e3b\u4ed3\u5e93\u5b8c\u5168\u72ec\u7acb\uff0c\u63d0\u4ea4\u8bb0\u5f55\u4e92\u4e0d\u5f71\u54cd\u3002<\/strong>\n<\/div>\n\n<!-- \u4e03\u3001GitLab Wiki -->\n<h2 id=\"zh-7\">\u4e03\u3001GitLab Wiki \u7279\u6027\u4e0e\u5dee\u5f02<\/h2>\n\n<h3>7.1 \u6838\u5fc3\u5dee\u5f02\u5bf9\u6bd4<\/h3>\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>\u7279\u6027<\/th><th>GitHub Wiki<\/th><th>GitLab Wiki<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>\u5e95\u5c42\u5b58\u50a8<\/td><td>\u72ec\u7acb .wiki.git \u4ed3\u5e93<\/td><td>\u9879\u76ee\u5185\u7684 Gollum Wiki<\/td><\/tr>\n <tr><td>\u514b\u9686\u65b9\u5f0f<\/td><td>repo.wiki.git<\/td><td>\u901a\u8fc7 API \u6216 Web \u754c\u9762<\/td><\/tr>\n <tr><td>\u9ed8\u8ba4\u683c\u5f0f<\/td><td>Markdown<\/td><td>Markdown<\/td><\/tr>\n <tr><td>\u6743\u9650\u6a21\u578b<\/td><td>\u7ee7\u627f\u4ed3\u5e93\u6743\u9650<\/td><td>\u7ee7\u627f\u9879\u76ee\u6743\u9650\uff0c\u53ef\u7ec6\u7c92\u5ea6\u63a7\u5236<\/td><\/tr>\n <tr><td>\u6a21\u677f\u529f\u80fd<\/td><td>\u65e0<\/td><td>\u652f\u6301 Wiki \u6a21\u677f\uff08\u7fa4\u7ec4\u7ea7\u522b\uff09<\/td><\/tr>\n <tr><td>API \u652f\u6301<\/td><td>\u901a\u8fc7 Wiki Git \u4ed3\u5e93<\/td><td>\u5b8c\u6574 REST API<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<h3>7.2 GitLab Wiki API \u64cd\u4f5c\u793a\u4f8b<\/h3>\n<pre class=\"terminal\"><span class=\"comment\"># \u521b\u5efa Wiki \u9875\u9762<\/span>\n<span class=\"prompt\">curl --request POST<\/span> \\\n --header \"PRIVATE-TOKEN: <your_token>\" \\\n --data \"title=Getting+Started\" \\\n --data \"content=%23+Getting+Started%0A%0AWelcome...\" \\\n \"https:\/\/gitlab.com\/api\/v4\/projects\/<id>\/wikis\"\n\n<span class=\"comment\"># \u5217\u51fa\u6240\u6709 Wiki \u9875\u9762<\/span>\n<span class=\"prompt\">curl --header<\/span> \"PRIVATE-TOKEN: <your_token>\" \\\n \"https:\/\/gitlab.com\/api\/v4\/projects\/<id>\/wikis\"\n<\/pre>\n\n<!-- \u516b\u3001\u5f00\u6e90\u9879\u76ee Wiki \u534f\u4f5c -->\n<h2 id=\"zh-8\">\u516b\u3001\u5f00\u6e90\u9879\u76ee Wiki \u534f\u4f5c\u89c4\u8303<\/h2>\n\n<h3>8.1 \u5f00\u6e90\u9879\u76ee Wiki \u5178\u578b\u7ed3\u6784<\/h3>\n<pre class=\"code-block\">Wiki\/\n\u251c\u2500\u2500 Home.md # \u9996\u9875\uff1a\u9879\u76ee\u7b80\u4ecb + Wiki \u5bfc\u822a\n\u251c\u2500\u2500 _Sidebar.md # \u4fa7\u8fb9\u680f\u5bfc\u822a\n\u251c\u2500\u2500 Getting-Started.md # \u65b0\u624b\u5feb\u901f\u4e0a\u624b\n\u251c\u2500\u2500 Installation.md # \u8be6\u7ec6\u5b89\u88c5\u6b65\u9aa4\n\u251c\u2500\u2500 Configuration.md # \u914d\u7f6e\u9879\u5b8c\u6574\u8bf4\u660e\n\u251c\u2500\u2500 Tutorials\/ # \u6559\u7a0b\u7cfb\u5217\n\u2502 \u251c\u2500\u2500 Basic-Usage.md\n\u2502 \u251c\u2500\u2500 Advanced-Features.md\n\u2502 \u2514\u2500\u2500 Examples.md\n\u251c\u2500\u2500 Architecture.md # \u67b6\u6784\u8bbe\u8ba1\u6587\u6863\n\u251c\u2500\u2500 Contributing.md # \u8d21\u732e\u6d41\u7a0b\uff08\u53ef\u955c\u50cf\u4ed3\u5e93 CONTRIBUTING.md\uff09\n\u251c\u2500\u2500 Code-of-Conduct.md # \u884c\u4e3a\u51c6\u5219\n\u251c\u2500\u2500 Changelog.md # \u7248\u672c\u53d8\u66f4\u8bb0\u5f55\n\u2514\u2500\u2500 FAQ.md # \u5e38\u89c1\u95ee\u9898\u89e3\u7b54\n<\/pre>\n\n<h3>8.2 \u534f\u4f5c\u89c4\u8303<\/h3>\n<div class=\"card\">\n <h4>\u5f00\u6e90 Wiki \u56db\u6761\u51c6\u5219<\/h4>\n <p>1. <span class=\"tag tag-b\">\u9996\u9875\u7d22\u5f15<\/span> Home.md \u5fc5\u987b\u63d0\u4f9b\u5b8c\u6574\u7684\u6587\u6863\u76ee\u5f55\u548c\u5feb\u901f\u5bfc\u822a\u94fe\u63a5<\/p>\n <p>2. <span class=\"tag tag-g\">\u4fdd\u6301\u66f4\u65b0<\/span> \u6bcf\u6b21\u53d1\u7248\u540c\u6b65\u66f4\u65b0 Changelog\uff0c\u5e9f\u5f03\u6587\u6863\u6807\u6ce8\u9192\u76ee\u63d0\u793a<\/p>\n <p>3. <span class=\"tag tag-y\">\u964d\u4f4e\u95e8\u69db<\/span> Getting-Started \u786e\u4fdd\u65b0\u624b 5 \u5206\u949f\u53ef\u8dd1\u901a\uff0c\u9644\u622a\u56fe\u6216\u547d\u4ee4<\/p>\n <p>4. <span class=\"tag tag-p\">\u5916\u90e8\u8d21\u732e\u8005<\/span> Wiki \u7f16\u8f91\u6743\u9650\u5f00\u653e\u7ed9 Write \u4ee5\u4e0a\u7684 Collaborator\uff0c\u9f13\u52b1\u793e\u533a\u8865\u5145\u6587\u6863<\/p>\n<\/div>\n\n<div class=\"info-box\">\n <strong>\u6280\u5de7\uff1a\u53ef\u4f7f\u7528 GitHub Actions \u81ea\u52a8\u540c\u6b65\u4ed3\u5e93\u4e2d\u7684 CONTRIBUTING.md \u548c CHANGELOG.md \u5230 Wiki\uff0c\u4fdd\u6301\u6587\u6863\u4e00\u81f4\u6027\u3002<\/strong>\n<\/div>\n\n<!-- \u4e5d\u3001\u6700\u4f73\u5b9e\u8df5 -->\n<h2 id=\"zh-9\">\u4e5d\u3001Wiki \u6700\u4f73\u5b9e\u8df5\u4e0e\u7ec4\u7ec7\u6a21\u677f<\/h2>\n\n<h3>9.1 \u4fe1\u606f\u67b6\u6784\u539f\u5219<\/h3>\n<div class=\"two-col\">\n <div class=\"col\">\n <h4>\u9875\u9762\u5c42\u7ea7\u63a7\u5236<\/h4>\n <p>Wiki \u4e0d\u652f\u6301\u7269\u7406\u76ee\u5f55\u5d4c\u5957\uff0c\u4f46\u53ef\u901a\u8fc7\u547d\u540d\u524d\u7f00\u6a21\u62df\u5c42\u7ea7\uff1a<\/p>\n <pre class=\"example\">Tutorials-Basic-Usage.md\nTutorials-Advanced-Features.md\nAPI-Endpoints-Auth.md\nAPI-Endpoints-Users.md<\/pre>\n <p>\u4fa7\u8fb9\u680f\u901a\u8fc7\u7f29\u8fdb\u6216\u5206\u7ec4\u6807\u9898\u7ec4\u7ec7\u89c6\u89c9\u5c42\u7ea7\u3002<\/p>\n <\/div>\n <div class=\"col\">\n <h4>\u5185\u5bb9\u5206\u5c42\u539f\u5219<\/h4>\n <p><span class=\"tag tag-g\">\u5165\u95e8\u5c42<\/span> \u5b89\u88c5\u3001\u5feb\u901f\u5f00\u59cb\u3001Hello World<\/p>\n <p><span class=\"tag tag-b\">\u4f7f\u7528\u5c42<\/span> \u914d\u7f6e\u3001API \u53c2\u8003\u3001\u6559\u7a0b\u3001\u793a\u4f8b<\/p>\n <p><span class=\"tag tag-p\">\u8fdb\u9636\u5c42<\/span> \u67b6\u6784\u8bbe\u8ba1\u3001\u6027\u80fd\u8c03\u4f18\u3001\u63d2\u4ef6\u5f00\u53d1<\/p>\n <p><span class=\"tag tag-y\">\u8fd0\u7ef4\u5c42<\/span> \u90e8\u7f72\u6307\u5357\u3001\u76d1\u63a7\u3001\u6545\u969c\u6392\u67e5<\/p>\n <\/div>\n<\/div>\n\n<h3>9.2 Home.md \u9996\u9875\u6a21\u677f<\/h3>\n<pre class=\"code-block\"># ProjectName Wiki\n\n> \u4e00\u53e5\u8bdd\u63cf\u8ff0\u9879\u76ee\u3002\n\n## \u5feb\u901f\u5f00\u59cb\n\u5982\u679c\u4f60\u662f\u7b2c\u4e00\u6b21\u63a5\u89e6\u672c\u9879\u76ee\uff0c\u8bf7\u6309\u987a\u5e8f\u9605\u8bfb\uff1a\n1. [[Getting-Started|\u5feb\u901f\u5f00\u59cb]] \u2014 5 \u5206\u949f\u4e0a\u624b\n2. [[Installation|\u5b89\u88c5\u6307\u5357]] \u2014 \u8be6\u7ec6\u5b89\u88c5\u6b65\u9aa4\n3. [[Configuration|\u914d\u7f6e\u8bf4\u660e]] \u2014 \u6240\u6709\u914d\u7f6e\u9879\u8bf4\u660e\n\n## \u6587\u6863\u76ee\u5f55\n- [[Architecture|\u7cfb\u7edf\u67b6\u6784]]\n- [[API-Reference|API \u53c2\u8003]]\n- [[Tutorials-Basic-Usage|\u57fa\u7840\u6559\u7a0b]]\n- [[Tutorials-Advanced-Features|\u8fdb\u9636\u6559\u7a0b]]\n- [[Deployment|\u90e8\u7f72\u6307\u5357]]\n\n## \u793e\u533a\n- [[Contributing|\u8d21\u732e\u6307\u5357]] \u2014 \u5982\u4f55\u53c2\u4e0e\u5f00\u53d1\n- [[FAQ|\u5e38\u89c1\u95ee\u9898]] \u2014 \u95ee\u9898\u6392\u67e5\n- [[Changelog|\u66f4\u65b0\u65e5\u5fd7]] \u2014 \u7248\u672c\u53d8\u66f4\u8bb0\u5f55\n<\/pre>\n\n<h3>9.3 Wiki \u4e0e\u4ed3\u5e93\u6587\u6863\u540c\u6b65\u7b56\u7565<\/h3>\n<div class=\"flow-diagram\">\n <div class=\"flow-row\">\n <span class=\"flow-item green\">\u4ed3\u5e93\u4ee3\u7801\u53d8\u66f4<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item\">GitHub Actions<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item yellow\">\u81ea\u52a8\u540c\u6b65<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item purple\">Wiki \u66f4\u65b0<\/span>\n <\/div>\n<\/div>\n\n<pre class=\"code-block\"># .github\/workflows\/sync-wiki.yml\nname: Sync Wiki\non:\n push:\n paths:\n - 'docs\/**'\n - 'CHANGELOG.md'\njobs:\n sync-wiki:\n runs-on: ubuntu-latest\n steps:\n - uses: actions\/checkout@v4\n - uses: Andrew-Chen-Wang\/github-wiki-action@v4\n with:\n path: docs\/\n token: ${{ secrets.GITHUB_TOKEN }}\n<\/pre>\n\n<!-- \u5341\u3001\u5e38\u89c1\u95ee\u9898 -->\n<h2 id=\"zh-10\">\u5341\u3001\u5e38\u89c1\u95ee\u9898\u4e0e\u89e3\u51b3\u65b9\u6848<\/h2>\n\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>\u95ee\u9898\u73b0\u8c61<\/th><th>\u539f\u56e0<\/th><th>\u89e3\u51b3\u65b9\u6848<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr>\n <td>Wiki \u6807\u7b7e\u9875\u663e\u793a 404<\/td>\n <td>\u4ed3\u5e93\u672a\u542f\u7528 Wiki \u6216\u65e0\u8bbf\u95ee\u6743\u9650<\/td>\n <td>Settings \u2192 Features \u2192 \u52fe\u9009 Wikis\uff1b\u68c0\u67e5\u4ed3\u5e93\u662f\u5426\u4e3a Private<\/td>\n <\/tr>\n <tr>\n <td>\u4fa7\u8fb9\u680f\u4e0d\u751f\u6548<\/td>\n <td>\u6587\u4ef6\u540d\u4e0d\u662f _Sidebar.md<\/td>\n <td>\u521b\u5efa\u540d\u4e3a _Sidebar.md \u7684\u9875\u9762\uff08\u4e0b\u5212\u7ebf\u5f00\u5934\uff0c\u5927\u5199 S\uff09<\/td>\n <\/tr>\n <tr>\n <td>Wiki \u5185\u94fe\u5931\u6548<\/td>\n <td>\u94fe\u63a5\u6587\u4ef6\u540d\u4e0e\u5b9e\u9645\u6587\u4ef6\u540d\u4e0d\u5339\u914d<\/td>\n <td>Wiki \u94fe\u63a5\u4f7f\u7528\u6587\u4ef6\u540d\uff08\u4e0d\u542b .md\uff09\uff0c\u6ce8\u610f\u5927\u5c0f\u5199\u548c\u8fde\u5b57\u7b26<\/td>\n <\/tr>\n <tr>\n <td>\u514b\u9686 Wiki \u4ed3\u5e93\u5931\u8d25<\/td>\n <td>\u5730\u5740\u9519\u8bef\u6216\u6743\u9650\u4e0d\u8db3<\/td>\n <td>\u786e\u8ba4\u5730\u5740\u4e3a repo.wiki.git\uff0c\u68c0\u67e5 SSH Key \u6216 Token<\/td>\n <\/tr>\n <tr>\n <td>Wiki \u56fe\u7247\u4e0d\u663e\u793a<\/td>\n <td>\u56fe\u7247\u672a\u901a\u8fc7 Wiki \u754c\u9762\u4e0a\u4f20<\/td>\n <td>\u5728 Wiki \u7f16\u8f91\u5668\u4e2d\u62d6\u62fd\u6216\u70b9\u51fb\u4e0a\u4f20\u56fe\u7247\uff0c\u4e0d\u8981\u5f15\u7528\u5916\u90e8\u8def\u5f84<\/td>\n <\/tr>\n <tr>\n <td>Wiki \u7f16\u8f91\u540e\u770b\u4e0d\u5230\u66f4\u65b0<\/td>\n <td>\u6d4f\u89c8\u5668\u7f13\u5b58<\/td>\n <td>\u5f3a\u5236\u5237\u65b0\u9875\u9762\uff08Ctrl+Shift+R\uff09<\/td>\n <\/tr>\n <tr>\n <td>Fork \u7684\u4ed3\u5e93 Wiki \u4e3a\u7a7a<\/td>\n <td>GitHub Fork \u9ed8\u8ba4\u4e0d\u590d\u5236 Wiki<\/td>\n <td>\u9700\u624b\u52a8\u514b\u9686\u539f\u59cb Wiki \u4ed3\u5e93\u5e76\u63a8\u9001\u5230 Fork<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<div class=\"info-box\">\n <strong>\u603b\u7ed3\uff1aRepo Wiki \u662f\u4ee3\u7801\u4ed3\u5e93\u539f\u751f\u7684\u8f7b\u91cf\u6587\u6863\u7cfb\u7edf\uff0c\u9002\u5408\u5b58\u653e\u6559\u7a0b\u3001FAQ\u3001\u8bbe\u8ba1\u6587\u6863\u7b49\u52a8\u6001\u77e5\u8bc6\u5185\u5bb9\u3002\u7ed3\u5408 _Sidebar.md \u7ec4\u7ec7\u5bfc\u822a\u3001\u672c\u5730 Git \u4ed3\u5e93\u6279\u91cf\u7f16\u8f91\u3001GitHub Actions \u81ea\u52a8\u540c\u6b65\uff0c\u53ef\u6784\u5efa\u9ad8\u6548\u7684\u56e2\u961f\u77e5\u8bc6\u7ba1\u7406\u4f53\u7cfb\u3002<\/strong>\n<\/div>\n\n<\/div>\n\n<!-- ======== \u82f1\u6587\u7248 ======== -->\n<div class=\"lang-section\" id=\"lang-en\">\n<div class=\"hero\">\n <h1>Repository Wiki Complete Guide<span class=\"sub\">GitHub \/ GitLab Wiki \u2014 From Setup to Effective Collaboration<\/span><\/h1>\n <p>What is Repo Wiki, Wiki vs README vs docs\/, creating and editing pages, sidebar navigation, local Git clone workflow, open-source collaboration, best practices & troubleshooting<\/p>\n<\/div>\n\n<div class=\"toc\">\n <h3>Table of Contents<\/h3>\n <ol>\n <li><a href=\"#en-1\">1 What is Repo Wiki & Core Purpose<\/a><\/li>\n <li><a href=\"#en-2\">2 Wiki vs README vs docs\/ Directory<\/a><\/li>\n <li><a href=\"#en-3\">3 GitHub Wiki Setup & Basic Operations<\/a><\/li>\n <li><a href=\"#en-4\">4 Page Creation & Markdown Authoring<\/a><\/li>\n <li><a href=\"#en-5\">5 Sidebar Navigation & Page Organization<\/a><\/li>\n <li><a href=\"#en-6\">6 Local Git Clone Workflow<\/a><\/li>\n <li><a href=\"#en-7\">7 GitLab Wiki Features & Differences<\/a><\/li>\n <li><a href=\"#en-8\">8 Open Source Wiki Collaboration<\/a><\/li>\n <li><a href=\"#en-9\">9 Best Practices & Templates<\/a><\/li>\n <li><a href=\"#en-10\">10 Common Issues & Solutions<\/a><\/li>\n <\/ol>\n<\/div>\n\n<h2 id=\"en-1\">1 What is Repo Wiki & Core Purpose<\/h2>\n<p>Repo Wiki is a built-in lightweight documentation system in GitHub \/ GitLab, attached directly to the code repository, providing a <strong>structured online documentation<\/strong> space for the project.<\/p>\n\n<div class=\"screenshot\">\n <div class=\"label\">Wiki tab location in a repository<\/div>\n <div class=\"mock\">\n <div class=\"mock-header\"><span class=\"tab\">Code<\/span><span class=\"tab\">Issues<\/span><span class=\"tab\">Pull requests<\/span><span class=\"tab\">Actions<\/span><span class=\"tab\" style=\"background:var(--accent2)\">Wiki<\/span><span class=\"tab\">Settings<\/span><\/div>\n <div class=\"mock-sidebar\">\n <div class=\"active\">Home<\/div>\n <div>Getting Started<\/div>\n <div>Architecture<\/div>\n <div>API Reference<\/div>\n <div>Deployment<\/div>\n <div>FAQ<\/div>\n <div>Changelog<\/div>\n <\/div>\n <div class=\"mock-content\">\n <strong>ProjectName Wiki<\/strong><br>\n Welcome to the ProjectName wiki! This space contains comprehensive documentation including setup guides, architecture overviews, and API references.\n <\/div>\n <\/div>\n<\/div>\n\n<div class=\"info-box\">\n <strong>Core Purpose: Wiki serves as the repository’s “knowledge base” \u2014 hosting project documentation, tutorials, design decisions, FAQ and other long-term content, managed under the same repository with unified permissions.<\/strong>\n<\/div>\n\n<div class=\"card\">\n <h4>Four Core Values of Wiki<\/h4>\n <p><span class=\"tag tag-b\">Zero Config<\/span> Built-in feature \u2014 no separate documentation site or build tools needed<\/p>\n <p><span class=\"tag tag-g\">Inherited Permissions<\/span> Automatically reuses repository Collaborator permissions<\/p>\n <p><span class=\"tag tag-y\">Version History<\/span> Every edit is versioned with diff and rollback support<\/p>\n <p><span class=\"tag tag-p\">Code Independent<\/span> Documentation changes don’t create commit noise in the main repo<\/p>\n<\/div>\n\n<h2 id=\"en-2\">2 Wiki vs README vs docs\/ Directory<\/h2>\n\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>Dimension<\/th><th>README.md<\/th><th>docs\/ Directory<\/th><th>Repo Wiki<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>Location<\/td><td>Repository root<\/td><td>docs\/ folder in repo<\/td><td>Wiki tab in repo<\/td><\/tr>\n <tr><td>Version Control<\/td><td>Git tracked<\/td><td>Git tracked<\/td><td>Separate Git repo (auto-managed)<\/td><\/tr>\n <tr><td>Visibility<\/td><td>Repo landing page<\/td><td>Navigate into folder<\/td><td>Dedicated Wiki page<\/td><\/tr>\n <tr><td>Best For<\/td><td>Project intro, quick start<\/td><td>API docs, detailed guides<\/td><td>Tutorials, FAQ, design docs<\/td><\/tr>\n <tr><td>Edit Access<\/td><td>Fork + PR<\/td><td>Fork + PR<\/td><td>Direct web edit (if permitted)<\/td><\/tr>\n <tr><td>Multi-page<\/td><td>Single file<\/td><td>Multiple files<\/td><td>Multiple pages + navigation<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<div class=\"compare-box\">\n <div class=\"compare-col good\">\n <h4>Recommended Strategy<\/h4>\n <p>README: Project card \u2014 one-liner + quick start<\/p>\n <p>docs\/: Version-tracked formal API docs<\/p>\n <p>Wiki: Dynamic knowledge base \u2014 tutorials, FAQ, design<\/p>\n <\/div>\n <div class=\"compare-col bad\">\n <h4>Common Mistakes<\/h4>\n <p>Stuffing all docs into README making it too long<\/p>\n <p>Duplicating content across Wiki and docs\/<\/p>\n <p>Important discussions scattered in Issues without Wiki<\/p>\n <\/div>\n<\/div>\n\n<h2 id=\"en-3\">3 GitHub Wiki Setup & Basic Operations<\/h2>\n\n<h3>3.1 Enable Wiki<\/h3>\n<ol class=\"steps\">\n <li>Open the repository and click the <code>Wiki<\/code> tab<\/li>\n <li>If first visit, click <strong>“Create the first page”<\/strong><\/li>\n <li>Default page name is <code>Home.md<\/code> \u2014 this becomes the Wiki landing page<\/li>\n <li>If disabled, admin goes to <strong>Settings \u2192 Features \u2192 Wikis<\/strong> to enable<\/li>\n<\/ol>\n\n<h3>3.2 Basic Page Operations<\/h3>\n<div class=\"cmd-grid\">\n <div class=\"cmd-card\">\n <h4>Create Page<\/h4>\n <div class=\"cmd\">Wiki right side \u2192 New Page<\/div>\n <div class=\"desc\">Enter title, .md filename auto-generated<\/div>\n <\/div>\n <div class=\"cmd-card\">\n <h4>Edit Page<\/h4>\n <div class=\"cmd\">Open page \u2192 Edit (top right)<\/div>\n <div class=\"desc\">Markdown editor with preview toggle<\/div>\n <\/div>\n <div class=\"cmd-card\">\n <h4>View History<\/h4>\n <div class=\"cmd\">Page History (top right)<\/div>\n <div class=\"desc\">All revisions with diff and rollback<\/div>\n <\/div>\n <div class=\"cmd-card\">\n <h4>Delete Page<\/h4>\n <div class=\"cmd\">Tools \u2192 Delete page<\/div>\n <div class=\"desc\">Recoverable from page history<\/div>\n <\/div>\n<\/div>\n\n<h2 id=\"en-4\">4 Page Creation & Markdown Authoring<\/h2>\n\n<h3>4.1 Supported Formats<\/h3>\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>Format<\/th><th>Extension<\/th><th>Notes<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>Markdown<\/td><td>.md<\/td><td>Recommended \u2014 best GitHub integration<\/td><\/tr>\n <tr><td>AsciiDoc<\/td><td>.adoc<\/td><td>For complex technical docs<\/td><\/tr>\n <tr><td>reStructuredText<\/td><td>.rst<\/td><td>Common in Python ecosystem<\/td><\/tr>\n <tr><td>Org Mode<\/td><td>.org<\/td><td>Emacs ecosystem markup<\/td><\/tr>\n <tr><td>MediaWiki<\/td><td>.mediawiki<\/td><td>Traditional wiki markup<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<h3>4.2 Internal Links & Asset References<\/h3>\n<pre class=\"code-block\"># Wiki internal links (use filename without extension)\n[[Getting-Started]]\n[[API-Reference|API Reference]] <!-- Custom display text -->\n\n# Reference Wiki-uploaded images\n\n\n# Link to repository files\n[View Source](https:\/\/github.com\/user\/repo\/blob\/main\/src\/main.py)\n<\/pre>\n\n<h2 id=\"en-5\">5 Sidebar Navigation & Page Organization<\/h2>\n\n<h3>5.1 Custom _Sidebar.md<\/h3>\n<pre class=\"code-block\"># _Sidebar.md\n\n## Quick Navigation\n\n- [[Home|Home]]\n- [[Getting-Started|Getting Started]]\n- [[Installation|Installation Guide]]\n\n## Documentation\n\n- [[Configuration|Configuration]]\n- [[API-Reference|API Reference]]\n- [[Plugins|Plugin Development]]\n\n## Advanced\n\n- [[Architecture|System Architecture]]\n- [[Performance|Performance Tuning]]\n\n## Community\n\n- [[Contributing|Contributing Guide]]\n- [[Changelog|Changelog]]\n- [[FAQ|FAQ]]\n<\/pre>\n\n<div class=\"info-box\">\n <strong>Special filenames: <code>_Sidebar.md<\/code> (left navigation), <code>_Footer.md<\/code> (page footer), <code>Home.md<\/code> (default landing page).<\/strong>\n<\/div>\n\n<h2 id=\"en-6\">6 Local Git Clone Workflow<\/h2>\n\n<div class=\"info-box\">\n <strong>GitHub Wiki is actually a separate Git repository \u2014 clone it locally for bulk editing with your preferred editor, then push back.<\/strong>\n<\/div>\n\n<pre class=\"terminal\"><span class=\"comment\"># Wiki repo URL = main repo URL + .wiki.git<\/span>\n<span class=\"prompt\">git clone<\/span> https:\/\/github.com\/user\/repo.wiki.git\n<span class=\"prompt\">cd<\/span> repo.wiki\n<span class=\"prompt\">ls<\/span>\n<span class=\"output\">Home.md _Sidebar.md Getting-Started.md API-Reference.md<\/span>\n\n<span class=\"comment\"># Edit locally, then push<\/span>\n<span class=\"prompt\">git add .<\/span>\n<span class=\"prompt\">git commit -m<\/span> \"docs: add API reference and configuration guide\"\n<span class=\"prompt\">git push origin master<\/span>\n<\/pre>\n\n<div class=\"flow-diagram\">\n <div class=\"flow-row\">\n <span class=\"flow-item green\">Clone Wiki<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item\">Local Edit<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item\">Git Commit<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item yellow\">Push Remote<\/span>\n <span class=\"flow-arrow\">→<\/span>\n <span class=\"flow-item purple\">Wiki Updated<\/span>\n <\/div>\n<\/div>\n\n<div class=\"info-box warn\">\n <strong>Wiki repo default branch is <code>master<\/code> (not main). Wiki repo is completely independent from the main repo \u2014 commit histories don’t interfere.<\/strong>\n<\/div>\n\n<h2 id=\"en-7\">7 GitLab Wiki Features & Differences<\/h2>\n\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>Feature<\/th><th>GitHub Wiki<\/th><th>GitLab Wiki<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>Storage<\/td><td>Separate .wiki.git repo<\/td><td>Project-internal Gollum Wiki<\/td><\/tr>\n <tr><td>Clone<\/td><td>repo.wiki.git<\/td><td>API or Web UI only<\/td><\/tr>\n <tr><td>Templates<\/td><td>Not supported<\/td><td>Group-level Wiki templates<\/td><\/tr>\n <tr><td>API<\/td><td>Via Git repo<\/td><td>Full REST API<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<h2 id=\"en-8\">8 Open Source Wiki Collaboration<\/h2>\n\n<h3>8.1 Typical Wiki Structure<\/h3>\n<pre class=\"code-block\">Wiki\/\n\u251c\u2500\u2500 Home.md\n\u251c\u2500\u2500 _Sidebar.md\n\u251c\u2500\u2500 Getting-Started.md\n\u251c\u2500\u2500 Installation.md\n\u251c\u2500\u2500 Configuration.md\n\u251c\u2500\u2500 Architecture.md\n\u251c\u2500\u2500 Contributing.md\n\u251c\u2500\u2500 Changelog.md\n\u2514\u2500\u2500 FAQ.md\n<\/pre>\n\n<div class=\"card\">\n <h4>Four Collaboration Rules<\/h4>\n <p>1. <span class=\"tag tag-b\">Home Index<\/span> Home.md must provide complete doc directory and quick links<\/p>\n <p>2. <span class=\"tag tag-g\">Stay Updated<\/span> Sync Changelog with each release; mark outdated docs<\/p>\n <p>3. <span class=\"tag tag-y\">Low Barrier<\/span> Getting-Started must be runnable in 5 minutes<\/p>\n <p>4. <span class=\"tag tag-p\">Community<\/span> Open Wiki write access to Collaborators; encourage contributions<\/p>\n<\/div>\n\n<h2 id=\"en-9\">9 Best Practices & Templates<\/h2>\n\n<div class=\"two-col\">\n <div class=\"col\">\n <h4>Simulated Hierarchy via Naming<\/h4>\n <pre class=\"example\">Tutorials-Basic-Usage.md\nTutorials-Advanced-Features.md\nAPI-Endpoints-Auth.md\nAPI-Endpoints-Users.md<\/pre>\n <\/div>\n <div class=\"col\">\n <h4>Content Layers<\/h4>\n <p><span class=\"tag tag-g\">Beginner<\/span> Install, quick start, hello world<\/p>\n <p><span class=\"tag tag-b\">Usage<\/span> Config, API reference, tutorials<\/p>\n <p><span class=\"tag tag-p\">Advanced<\/span> Architecture, performance, plugins<\/p>\n <p><span class=\"tag tag-y\">Operations<\/span> Deploy, monitoring, troubleshooting<\/p>\n <\/div>\n<\/div>\n\n<h3>9.1 Auto-Sync with GitHub Actions<\/h3>\n<pre class=\"code-block\"># .github\/workflows\/sync-wiki.yml\nname: Sync Wiki\non:\n push:\n paths:\n - 'docs\/**'\n - 'CHANGELOG.md'\njobs:\n sync-wiki:\n runs-on: ubuntu-latest\n steps:\n - uses: actions\/checkout@v4\n - uses: Andrew-Chen-Wang\/github-wiki-action@v4\n with:\n path: docs\/\n token: ${{ secrets.GITHUB_TOKEN }}\n<\/pre>\n\n<h2 id=\"en-10\">10 Common Issues & Solutions<\/h2>\n\n<div class=\"table-wrap\">\n<table>\n <thead>\n <tr><th>Issue<\/th><th>Cause<\/th><th>Solution<\/th><\/tr>\n <\/thead>\n <tbody>\n <tr><td>Wiki tab shows 404<\/td><td>Wiki disabled or no access<\/td><td>Settings \u2192 Features \u2192 enable Wikis<\/td><\/tr>\n <tr><td>Sidebar not working<\/td><td>Filename incorrect<\/td><td>Must be exactly _Sidebar.md<\/td><\/tr>\n <tr><td>Internal links broken<\/td><td>Filename mismatch<\/td><td>Use filename without .md, match case<\/td><\/tr>\n <tr><td>Clone fails<\/td><td>Wrong URL or permissions<\/td><td>Use repo.wiki.git, check SSH\/token<\/td><\/tr>\n <tr><td>Images not displaying<\/td><td>Not uploaded via Wiki UI<\/td><td>Upload images through Wiki editor<\/td><\/tr>\n <tr><td>Fork has empty Wiki<\/td><td>Fork doesn’t copy Wiki<\/td><td>Manually clone & push original Wiki<\/td><\/tr>\n <\/tbody>\n<\/table>\n<\/div>\n\n<div class=\"info-box\">\n <strong>Summary: Repo Wiki is a native lightweight documentation system for code repositories, ideal for tutorials, FAQ, and design docs. Combine _Sidebar.md navigation, local Git clone editing, and GitHub Actions sync to build an efficient team knowledge management system.<\/strong>\n<\/div>\n\n<\/div>\n<\/main>\n\n<footer>\n <div class=\"links\">\n <a href=\"https:\/\/docs.github.com\/en\/communities\/documenting-your-project-with-wikis\/about-wikis\" target=\"_blank\" rel=\"noopener\">GitHub Wiki Docs<\/a>\n <a href=\"https:\/\/docs.gitlab.com\/ee\/user\/project\/wiki\/\" target=\"_blank\" rel=\"noopener\">GitLab Wiki Docs<\/a>\n <a href=\"https:\/\/github.com\/Andrew-Chen-Wang\/github-wiki-action\" target=\"_blank\" rel=\"noopener\">Wiki Sync Action<\/a>\n <\/div>\n <p>Repository Wiki Complete Guide<\/p>\n<\/footer>\n\n<script>\nfunction setLang(lang){\n document.querySelectorAll('.lang-section').forEach(el=>el.classList.remove('active'));\n document.getElementById('lang-'+lang).classList.add('active');\n document.querySelectorAll('.lang-switch button').forEach(btn=>btn.classList.remove('active'));\n document.getElementById('btn-'+lang).classList.add('active');\n document.documentElement.lang = lang==='zh'?'zh-CN':'en';\n const prefix = lang==='zh'?'zh':'en';\n const newHash = window.location.hash.replace(\/^#(zh|en)-\/, prefix+\"-\");\n if(newHash) window.location.hash = newHash;\n}\nfunction toggleTheme(){\n const html = document.documentElement;\n if(html.hasAttribute('data-theme')){\n html.removeAttribute('data-theme');\n localStorage.removeItem('theme');\n }else{\n html.setAttribute('data-theme','dark');\n localStorage.setItem('theme','dark');\n }\n}\n(function(){\n if(localStorage.getItem('theme')==='dark') document.documentElement.setAttribute('data-theme','dark');\n const hash = window.location.hash;\n if(hash){\n const target = document.querySelector(hash);\n if(target) setTimeout(()=>target.scrollIntoView({behavior:'smooth'}),100);\n }\n})();\n<\/script>\n<\/body>\n<\/html>\n","protected":false},"excerpt":{"rendered":"<p>Repo Wiki \u5b8c\u6574\u6307\u5357 \u00b7 Repository Wiki Full Guide 📚 R […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11,9],"tags":[],"class_list":["post-352","post","type-post","status-publish","format-standard","hentry","category-cad","category-ai"],"blocksy_meta":[],"_links":{"self":[{"href":"https:\/\/numsimlab.com\/index.php?rest_route=\/wp\/v2\/posts\/352","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/numsimlab.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/numsimlab.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/numsimlab.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/numsimlab.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=352"}],"version-history":[{"count":1,"href":"https:\/\/numsimlab.com\/index.php?rest_route=\/wp\/v2\/posts\/352\/revisions"}],"predecessor-version":[{"id":353,"href":"https:\/\/numsimlab.com\/index.php?rest_route=\/wp\/v2\/posts\/352\/revisions\/353"}],"wp:attachment":[{"href":"https:\/\/numsimlab.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=352"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/numsimlab.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=352"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/numsimlab.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=352"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}