如何生成Semantic UI离线文档

Question

我已经很久没有生成文档了(因为0.19.3),似乎文档是分开的.

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

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

你能指导我怎么做吗？

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

Answer 1

这里回答

只需选择您缺少的内容即可完成.(它可能有一些错别字.)

需要终端.

假设文件夹结构:

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

NB

所有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/)

用户界面:

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)

NB

如果您不想克隆所有SUI回购历史记录,请阅读:#220(评论)

全局和本地安装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

要么:

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

然后在本地安装学习:

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

注意:要在本地更新(docpad和插件),请执行:docpad update在docs和learn文件夹中.

NB

docpad更新清洗/抹杀的文档/文件夹进行(这是由填充用蒸馏水和src文件夹和文件gulp build-docs,gulp-serve-docs以及docpad run),所以在时机成熟时,运行docpad update从构建文档之前ui文件夹.npm install docpad以root用户身份运行/管理员(以避免权限问题).

绝对在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那么您应该是全自动的.