如何生成Semantic UI离线文档

Question

很长一段时间我一直在生成文档（自0.19.3以来），似乎是doc was separated。

我不知道如何生成文档，因为它没有得到很好的解释：

  

在运行服务器之前，您需要为文档构建UI文件。语义UI包括一个特殊命令，用于为必须从相邻Semantic UI文件夹运行的docs实例构建文件。例如，使用目录供应商 - ＆gt; SemanticUI将docs文件夹放在供应商内部以反映供应商 - ＆gt; SemanticUI |文档

你能指导我怎么做吗？

从Semantic UI source，我运行npm install，它安装了所有需要的东西，然后当我运行gulp build-docs时，它生成了一个docs文件夹，它位于源外，这个，如果我在其中运行命令docpad run，我没有得到正确的HTML，因为我不知道在哪里下载分离的文档。

Answer 1

已回答here

选择你缺少的东西来完成它。 （可能有一些拼写错误。）

需要终端。

假设文件夹结构：

path/to/your/bull polished/project
 |
 `_ docs
 |
 `_ learn
 |
 `_ ui

N.B。

所有3个子文件夹docs, learn, ui可能会有不同的名称。 子文件夹docs和ui 必须是相邻的文件夹。

目前learnsemantic.com（learn）独立于其他2个回购。所以它可以放在你喜欢的任何地方。

克隆回购：

cd path/to/your/bull polished/project

文档：

git clone --recursive --progress -v "git@github.com:Semantic-Org/Semantic-UI-Docs.git" "docs"
Cloned https://github.com/Semantic-Org/Semantic-UI-Docs (http://semantic-ui.com/)

学

git clone --recursive --progress -v "git@github.com:Semantic-Org/Learn-Semantic.git" "learn"
Cloned https://github.com/Semantic-Org/Learn-Semantic (http://learnsemantic.com/)

UI：

git clone --recursive --progress -v "git@github.com:Semantic-Org/Semantic-UI.git" "ui"
Cloned https://github.com/Semantic-Org/Semantic-UI (The Semantic UI framework)

N.B。

如果您不想克隆所有SUI回购历史记录，请阅读：#220 (comment)

全局和本地安装Gulp。

npm install -g gulp
cd "path/to/your/bull polished/project/ui"
npm install gulp

安装Semantic UI框架。

(Still in : "path/to/your/bull polished/project/ui")

npm install
gulp

OR：

gulp install

全局和本地安装Docpad。在本地安装Docpad插件。

全球安装：

npm install -g docpad

注意：全局更新docpad upgrade

然后在本地安装到docs：

cd "path/to/your/bull polished/project/docs"
npm install docpad
docpad install eco

然后在本地安装到learn：

cd "path/to/your/bull polished/project/learn"
npm install docpad
docpad install eco

注意：要在本地更新（docpad和插件），请在docpad update和docs文件夹中运行learn。

<强> NB

docpad update会清除/删除docs / out文件夹（其中包含dist和src文件夹，文件由gulp build-docs，gulp-serve-docs和docpad run填充 所以到时候，在docpad update文件夹构建文档之前运行ui。 以root / Administrator身份运行npm install docpad（以避免权限问题）。

绝对在Windows上。

有时也在Linux / OS X上，如果Node“安装错误”。 但至少在Linux / OS X上你可以重新安装Node来纠正这个问题。 请参阅：node-forward/help#4

构建语义UI框架：

cd "path/to/your/bull polished/project/ui"
Only if required:

gulp clean
Followed by:

gulp build OR gulp watch

在docs文件夹中为文档构建语义UI框架：

cd "path/to/your/bull polished/project/ui"

gulp build-docs或gulp serve-docs     gulp build-docs：创建并填充docs / out / dist和docs / out / src     gulp serve-docs：ui文件夹中的源文件更改和更新文件夹docs / out / dist和docs / out / src。

生成Semantic UI Documentation页面并启动本地服务器：

cd "path/to/your/bull polished/project/docs"
docpad run
docpad run : Creates all documentation files and folders (other than docs/out/dist and docs/out/src) in the docs/out folder.

生成learnsemantic.com页面并启动本地服务器：

cd "path/to/your/bull polished/project/learn"
docpad run
docpad run : Creates all documentation files and folders in the learn/out folder.

当您更改SUI框架变量等

时

1）对框架进行更改。

2）重建框架：

gulp clean (only when necessary)
gulp build OR gulp watch

3）更新文档：     gulp build-docs或gulp serve-docs

4）生成文档页面。     docpad运行或docpad服务器

回到1）

如果您使用gulp watch和gulp serve-docs，则应该完全自动化。