如何生成 Semantic UI 离线文档
How to generate Semantic UI offline doc
我已经有很长时间没有生成文档了(自 0.19.3
),似乎 doc was separated.
我不知道如何生成文档,因为它没有很好地解释:
Before running server you will need to build your UI files for the docs. Semantic UI includes a special command to build files for a docs instance that must be run from an adjacent Semantic UI folder. for example with a directory vendor -> SemanticUI place docs folder inside vendor to reflect vendor -> SemanticUI | docs
你能指导我怎么做吗?
从 Semantic UI source, i 运行 npm install
,它安装了所有需要的东西,然后当我 运行 gulp build-docs
它生成了一个 docs
文件夹在源之外,这个,如果我 运行 在里面命令 docpad run
,我没有得到正确的 HTML,因为我不知道把分离的放在哪里已下载文档。
已回答here
只需选择您缺少的内容即可完成。
(它可能有一些错别字。)
需要一个终端ui红色。
假定的文件夹结构:
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
安装语义 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
然后在本地安装到learn:
cd "path/to/your/bull polished/project/learn"
npm install docpad
docpad install eco
注意: 本地更新(docpad 和插件)运行:docpad update
在 docs
和 learn
文件夹中.
NB
docpad 更新 purges/obliterates docs/out 文件夹(其中包含 dist 和 src 文件夹,以及 gulp build-docs
、gulp-serve-docs
和 docpad run
的文件)
所以当时机成熟时,运行 docpad update
在 bui 从 ui
文件夹中加载文档之前。
运行 npm install docpad
as root/Administrator(以避免权限问题)。
肯定会 Windows。
有时也在 Linux/OS X 上,如果安装了 Node "incorrectly"。
但至少在 Linux/OS X 上你可以重新安装 Node 来纠正这个问题。
参见:node-forward/help#4
Build 语义 UI 框架:
cd "path/to/your/bull polished/project/ui"
Only if required:
gulp clean
Followed by:
gulp build OR gulp watch
Build 文档文件夹中文档的语义 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.
生成语义 UI 文档页面并启动本地服务器:
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) Rebuild 框架:
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
,您应该是全自动的。
我已经有很长时间没有生成文档了(自 0.19.3
),似乎 doc was separated.
我不知道如何生成文档,因为它没有很好地解释:
Before running server you will need to build your UI files for the docs. Semantic UI includes a special command to build files for a docs instance that must be run from an adjacent Semantic UI folder. for example with a directory vendor -> SemanticUI place docs folder inside vendor to reflect vendor -> SemanticUI | docs
你能指导我怎么做吗?
从 Semantic UI source, i 运行 npm install
,它安装了所有需要的东西,然后当我 运行 gulp build-docs
它生成了一个 docs
文件夹在源之外,这个,如果我 运行 在里面命令 docpad run
,我没有得到正确的 HTML,因为我不知道把分离的放在哪里已下载文档。
已回答here
只需选择您缺少的内容即可完成。 (它可能有一些错别字。)
需要一个终端ui红色。
假定的文件夹结构:
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
安装语义 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
然后在本地安装到learn:
cd "path/to/your/bull polished/project/learn"
npm install docpad
docpad install eco
注意: 本地更新(docpad 和插件)运行:docpad update
在 docs
和 learn
文件夹中.
NB
docpad 更新 purges/obliterates docs/out 文件夹(其中包含 dist 和 src 文件夹,以及 gulp build-docs
、gulp-serve-docs
和 docpad run
的文件)
所以当时机成熟时,运行 docpad update
在 bui 从 ui
文件夹中加载文档之前。
运行 npm install docpad
as root/Administrator(以避免权限问题)。
肯定会 Windows。
有时也在 Linux/OS X 上,如果安装了 Node "incorrectly"。 但至少在 Linux/OS X 上你可以重新安装 Node 来纠正这个问题。 参见:node-forward/help#4
Build 语义 UI 框架:
cd "path/to/your/bull polished/project/ui"
Only if required:
gulp clean
Followed by:
gulp build OR gulp watch
Build 文档文件夹中文档的语义 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.
生成语义 UI 文档页面并启动本地服务器:
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) Rebuild 框架:
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
,您应该是全自动的。