<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0"><channel><title><![CDATA[MkDocs是什么？]]></title><description><![CDATA[<p dir="auto">下面我按**“你现在的认知起点”<strong>来解释，不假设你知道 MkDocs，也不站在“工具爱好者”的角度，而是站在</strong>一个要管理 500+ 仓库、异地团队、AI 高频产出**的技术负责人的视角。</p>
<hr />
<h1>一、MkDocs 是什么？一句话先给你结论</h1>
<p dir="auto"><strong>MkDocs = 把 Markdown 目录，自动变成“可搜索、可导航、可长期维护”的文档网站的引擎。</strong></p>
<p dir="auto">它不是用来“写文档”的，而是用来：</p>
<blockquote>
<p dir="auto"><strong>把你已经写好的 Markdown，组织、发布、持续演进。</strong></p>
</blockquote>
<hr />
<h2>MkDocs 不解决什么</h2>
<ul>
<li>不负责写 Markdown（AI / 人写）</li>
<li>不负责讨论（NodeBB 才是）</li>
<li>不负责权限（GitLab / Pages / 反向代理）</li>
</ul>
<h2>MkDocs 专门解决什么</h2>
<ul>
<li>Markdown → 结构化网站</li>
<li>统一目录、侧边栏、全文搜索</li>
<li>多人协作、版本可追溯</li>
<li>自动发布（CI 驱动）</li>
</ul>
<hr />
<h1>二、MkDocs 在你这个场景里的“真实角色”</h1>
<p dir="auto">你现在的问题是：</p>
<blockquote>
<p dir="auto">AI 每天生成大量 md<br />
团队不在一个城市<br />
项目 500+<br />
不能让大家“翻帖子考古”</p>
</blockquote>
<p dir="auto">在这个体系里：</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>组件</th>
<th>角色</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Markdown</strong></td>
<td>原材料（AI 产出）</td>
</tr>
<tr>
<td><strong>GitLab</strong></td>
<td>单一事实源（谁改了什么）</td>
</tr>
<tr>
<td><strong>MkDocs</strong></td>
<td><strong>把“散乱 md”变成“可用知识库”</strong></td>
</tr>
<tr>
<td><strong>GitLab Pages</strong></td>
<td>稳定发布</td>
</tr>
<tr>
<td><strong>NodeBB</strong></td>
<td>通知 + 讨论</td>
</tr>
</tbody>
</table>
<blockquote>
<p dir="auto">MkDocs 是“知识仓库引擎”，不是“交流工具”。</p>
</blockquote>
<hr />
<h1>三、MkDocs 到底长什么样（不用你想象）</h1>
<p dir="auto">MkDocs 生成的是一个<strong>典型的技术文档站</strong>：</p>
<ul>
<li>左侧：目录树（按你定义）</li>
<li>右侧：正文（Markdown 渲染）</li>
<li>顶部：搜索框（全文搜索）</li>
<li>URL 稳定、可引用、可长期保存</li>
</ul>
<p dir="auto">这类站点的特点是：</p>
<ul>
<li><strong>3 个月后还能看懂</strong></li>
<li><strong>1 年后链接还有效</strong></li>
<li><strong>新人能顺着目录自学</strong></li>
<li><strong>AI 写的文档不会“沉没”</strong></li>
</ul>
<p dir="auto">这正是论坛/聊天工具永远做不好的事情。</p>
<hr />
<h1>四、MkDocs 的工作方式（你会秒懂）</h1>
<h3>1️⃣ 你只关心这个目录</h3>
<pre><code class="language-text">docs/
  index.md
  now/
    README.md
  daily/
    2026-01-05.md
  decisions/
    adr-0001-auth.md
</code></pre>
<h3>2️⃣ MkDocs 只做一件事</h3>
<blockquote>
<p dir="auto">读取 <code>docs/</code> → 生成一个静态网站</p>
</blockquote>
<h3>3️⃣ 唯一的“配置文件”：<code>mkdocs.yml</code></h3>
<pre><code class="language-yaml">site_name: 团队知识库
nav:
  - 首页: index.md
  - 我在做什么: now/README.md
  - 日报:
      - 2026-01-05: daily/2026-01-05.md
  - 架构决策: decisions/
theme:
  name: material
</code></pre>
<p dir="auto"><strong>你改的不是网页，而是目录结构。</strong></p>
<hr />
<h1>五、为什么不用 NodeBB 直接发帖？这是关键问题</h1>
<p dir="auto">你这个问题问得非常好，而且<strong>80% 的团队一开始都会走错这一步</strong>。</p>
<h2>NodeBB 发帖，看起来很“直接”，但在你规模下会出灾难</h2>
<p dir="auto">我直接给你对比结论：</p>
<hr />
<h2>1️⃣ 信息“寿命”完全不同</h2>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>维度</th>
<th>NodeBB 帖子</th>
<th>MkDocs 文档</th>
</tr>
</thead>
<tbody>
<tr>
<td>可见期</td>
<td>3～7 天</td>
<td><strong>3～5 年</strong></td>
</tr>
<tr>
<td>查找方式</td>
<td>搜索关键词</td>
<td><strong>目录 + 搜索</strong></td>
</tr>
<tr>
<td>链接稳定性</td>
<td><img src="https://talk.loda.net/assets/plugins/nodebb-plugin-emoji/emoji/android/274c.png?v=7ba14356ba6" class="not-responsive emoji emoji-android emoji--x" style="height:23px;width:auto;vertical-align:middle" title="❌" alt="❌" /> 易被淹没</td>
<td><strong><img src="https://talk.loda.net/assets/plugins/nodebb-plugin-emoji/emoji/android/2705.png?v=7ba14356ba6" class="not-responsive emoji emoji-android emoji--white_check_mark" style="height:23px;width:auto;vertical-align:middle" title="✅" alt="✅" /> 永久链接</strong></td>
</tr>
<tr>
<td>结构化</td>
<td><img src="https://talk.loda.net/assets/plugins/nodebb-plugin-emoji/emoji/android/274c.png?v=7ba14356ba6" class="not-responsive emoji emoji-android emoji--x" style="height:23px;width:auto;vertical-align:middle" title="❌" alt="❌" /></td>
<td><strong><img src="https://talk.loda.net/assets/plugins/nodebb-plugin-emoji/emoji/android/2705.png?v=7ba14356ba6" class="not-responsive emoji emoji-android emoji--white_check_mark" style="height:23px;width:auto;vertical-align:middle" title="✅" alt="✅" /> 强</strong></td>
</tr>
</tbody>
</table>
<p dir="auto"><strong>论坛适合“现在讨论什么”，不适合“我们最终决定了什么”。</strong></p>
<hr />
<h2>2️⃣ 500 项目 + NodeBB = 考古现场</h2>
<p dir="auto">你可以想象一下半年后：</p>
<ul>
<li>“那个关于 AuthServer 改造的帖子在哪？”</li>
<li>“好像在 NodeBB？还是微信群？”</li>
<li>“是哪个版本的决策？”</li>
</ul>
<p dir="auto">而 MkDocs 的模式是：</p>
<pre><code>架构决策
 ├─ adr-0001-auth-server.md
 ├─ adr-0002-oidc-nodebb.md
</code></pre>
<p dir="auto"><strong>不是靠记忆，是靠路径。</strong></p>
<hr />
<h2>3️⃣ NodeBB 不适合“版本演进”</h2>
<p dir="auto">你是 .NET / ABP / 基础设施重构型团队：</p>
<ul>
<li>v1 决策</li>
<li>v2 推翻</li>
<li>v3 新方案</li>
</ul>
<p dir="auto">NodeBB 的时间线是<strong>线性的</strong>，而文档是<strong>演进式的</strong>。</p>
<p dir="auto">MkDocs + Git 的优势是：</p>
<ul>
<li>diff 看变更</li>
<li>commit 说明为什么变</li>
<li>旧决策可追溯</li>
</ul>
<hr />
<h2>4️⃣ AI 产出在 NodeBB 会“失控”</h2>
<p dir="auto">AI 非常擅长：</p>
<ul>
<li>写长文</li>
<li>写方案</li>
<li>写对比</li>
</ul>
<p dir="auto">但 <strong>论坛</strong>：</p>
<ul>
<li>没有审阅门槛</li>
<li>没有目录约束</li>
<li>没有生命周期管理</li>
</ul>
<p dir="auto">结果一定是：</p>
<blockquote>
<p dir="auto">信息爆炸 → 噪音淹没 → 再也没人看</p>
</blockquote>
<p dir="auto">MkDocs 强迫你做一件事：</p>
<blockquote>
<p dir="auto"><strong>“这个文档，应该放在哪个位置？”</strong></p>
</blockquote>
<p dir="auto">这是好事，不是负担。</p>
<hr />
<h1>六、那 NodeBB 该怎么用？（正确姿势）</h1>
<p dir="auto">不是不用 NodeBB，而是<strong>只让它做它擅长的事</strong>：</p>
<h3>NodeBB = “广播 + 讨论入口”</h3>
<p dir="auto">发布策略建议：</p>
<blockquote>
<p dir="auto"><strong>NodeBB 帖子永远只做一件事：</strong><br />
<img src="https://talk.loda.net/assets/plugins/nodebb-plugin-emoji/emoji/android/1f449.png?v=7ba14356ba6" class="not-responsive emoji emoji-android emoji--point_right" style="height:23px;width:auto;vertical-align:middle" title="👉" alt="👉" /> 告诉大家：<strong>“有新内容/新决策/新文档了，在这里”</strong></p>
</blockquote>
<p dir="auto">帖子结构固定化：</p>
<pre><code>标题：📌 架构决策更新：统一 OIDC 登录方案

正文：
- 背景：多系统登录混乱
- 结论：统一走 id.loda.net
- 影响范围：NodeBB / ERP / Admin
- 文档地址：https://docs.xxx.com/decisions/adr-0003-oidc.html

👇 讨论放在本帖
</code></pre>
<p dir="auto"><strong>讨论在 NodeBB，结论在 MkDocs。</strong></p>
<hr />
<h1>七、这套模式在“异地 + 高频 AI + 大规模仓库”下为什么稳定</h1>
<p dir="auto">你现在的情况非常典型：</p>
<ul>
<li>AI 写得快</li>
<li>人分散</li>
<li>项目爆炸</li>
<li>历史包袱重</li>
</ul>
<p dir="auto">MkDocs 给你的不是“更好看的文档”，而是：</p>
<ol>
<li><strong>强制沉淀</strong>（不写就不存在）</li>
<li><strong>低摩擦协作</strong>（Markdown + Git）</li>
<li><strong>可审计演进</strong>（谁、何时、为何）</li>
<li><strong>新人可自学</strong>（不依赖你反复解释）</li>
</ol>
<p dir="auto">而 NodeBB：</p>
<ul>
<li>负责“告诉大家发生了什么”</li>
<li>负责“大家怎么看”</li>
</ul>
<hr />
<h1>八、一句话总结给你</h1>
<blockquote>
<p dir="auto"><strong>NodeBB 是“现在聊什么”，MkDocs 是“我们最终怎么做”。</strong><br />
<strong>没有 MkDocs，你的 AI 产出一定会在 3 个月内失效。</strong></p>
</blockquote>
<hr />
<h2>下一步我建议你做什么（非常具体）</h2>
<ol>
<li>
<p dir="auto">先 <strong>不管 500 个项目</strong></p>
</li>
<li>
<p dir="auto">只用 MkDocs 管三类内容：</p>
<ul>
<li><code>now/</code>（你在干什么）</li>
<li><code>daily/</code>（你每天产出的 AI 结果）</li>
<li><code>decisions/</code>（你真正拍板的事情）</li>
</ul>
</li>
<li>
<p dir="auto">NodeBB 只发“变更通知帖 + 链接”</p>
</li>
</ol>
<p dir="auto">如果你愿意，下一步我可以直接给你一份：</p>
<ul>
<li><strong>极简 mkdocs.yml（你不需要理解）</strong></li>
<li><strong>3 个模板 md（now / daily / adr）</strong></li>
<li><strong>一个 CI：push → Pages 自动更新 → NodeBB/企业微信通知</strong></li>
</ul>
<p dir="auto">你只需要照着填内容，不需要“学 MkDocs”。</p>
]]></description><link>https://talk.loda.net/topic/41/mkdocs是什么</link><generator>RSS for Node</generator><lastBuildDate>Fri, 17 Apr 2026 08:32:16 GMT</lastBuildDate><atom:link href="https://talk.loda.net/topic/41.rss" rel="self" type="application/rss+xml"/><pubDate>Mon, 05 Jan 2026 19:20:22 GMT</pubDate><ttl>60</ttl></channel></rss>