快速上手

前提条件

SDoc 需要 Node.js >= 10

本文会帮助你从头搭建一个简单的 SDoc 文档。如果你想在一个现有项目中使用 SDoc 管理文档，从步骤 3 开始。

1. 创建并进入一个新目录

mkdir sdoc-starter && cd sdoc-starter

2. 使用你喜欢的包管理器进行初始化

yarn init # npm init

3. 将 SDoc 安装为本地依赖

我们已经不再推荐全局安装 SDoc

yarn add -D @sdoc/cli # npm install -D @sdoc/cli

注意

如果你的现有项目依赖了 webpack 3.x，我们推荐使用 Yarn 而不是 npm 来安装 SDoc。因为在这种情形下，npm 会生成错误的依赖树。

4. 创建你的第一篇文档

mkdir docs && echo '# Hello SDoc' > docs/README.md

5. 在 package.json 中添加一些 scripts

这一步骤是可选的，但我们推荐你完成它。在下文中，我们会默认这些 scripts 已经被添加。

{
  "scripts": {
    "docs:start": "sdoc start docs",
    "docs:build": "sdoc build docs"
  }
}

6. 在本地启动服务器

yarn docs:start # npm run docs:start

SDoc 会在 http://localhost:8080 启动一个热重载的开发服务器。

现在，你应该已经有了一个简单可用的 SDoc 文档。接下来，了解一下推荐的 目录结构 和 SDoc 中的 基本配置。