docdoc 文档

第一个文档站

完成本任务后，你将得到一个本地可预览的文档站，并理解「源目录 → 构建 → 预览」这条主流程。

前置条件：已完成安装（站内搜索 ?安装）。

操作步骤

  1. 创建源目录并写入首页：

    mkdir my-docs
cat > my-docs/docdoc.json <<'EOF'
{ "title": "My Docs" }
EOF
cat > my-docs/index.md <<'EOF'
# 我的文档

第一页内容。
EOF

  2. 启动本地预览：

    docdoc preview ./my-docs

    终端输出：

    构建完成：1 页
预览服务已启动: http://127.0.0.1:3000/
已监听源目录变化: ./my-docs

  3. 浏览器访问 http://127.0.0.1:3000/，看到渲染后的「我的文档」页面。

  4. 修改 my-docs/index.md 内容并保存，终端输出 重建完成：1 页，刷新浏览器即看到最新内容。

补充说明

  • 预览端口被占用时用 --port 换一个：docdoc preview ./my-docs --port 3100
  • 只想要产物不启动服务时，用 docdoc build ./my-docs --output ./site（用途与选项说明见站内搜索 ?build 命令）
  • 源目录也可以没有 docdoc.json：此时整个目录按无清单模式直出为单个文档，站点标题显示为 Docs