如何使用离线资源构建 YUIDoc?

How can I build YUIDoc with offline resources?

当您构建 & 运行 YUIDoc 时,它会从 http://yui.yahooapis.com/... 获取他的一些资源。这些资源包括样式表和 yui.min.js.
如何离线下载和使用这些资源?

这是因为我们 运行 我们的文档在 HTTPS 服务器上。 YUIDoc 始终通过 HTTP 协议提供他的文件。

我遇到了同样的问题,我真的不明白为什么 yui.yahooapis.com 没有有效的证书。这是对我有用的(使用 YUIDoc 0.5.0):

创建自定义主题

首先,您需要创建一个新主题来覆盖默认主题的某些部分。

创建以下文件夹结构:

my_theme
├── assets
│   ├── css
│   └── yui
└── layouts

修改主布局

为避免加载远程 CSS 和脚本,您需要更改主布局。

将名为 main.handlebars 的文件从原始主题复制到您的 my_theme/layouts/ 文件夹中。如果你通过节点​​安装 YUIDoc,原始文件位于 node_modules/yuidocjs/themes/default/layouts/。或者,您可以从 yuidoc GitHub repo.

中获取它

在该文件中进行以下更改:

1.) 替换引用远程样式表的 link 标签:

<link rel="stylesheet" href="{{yuiGridsUrl}}">
<link rel="stylesheet" href="{{projectAssets}}/css/cssgrids-min.css">

2.) 替换引用远程 YUI 库的 script 标签:

<script src="{{yuiSeedUrl}}"></script>
<script src="{{projectAssets}}/yui/build/yui-base/yui-base-min.js"></script>

添加远程资产的本地副本

1.) 从 Yahoo 的 CDN

获取 CSS

从 Yahoo CDN 下载 cssgrids-min.css 并将其放入您的 my_theme/assets/css 文件夹。

2.) 下载 YUI 3.9.1 库

http://yui.zenfs.com/releases/yui3/yui_3.9.1.zip (Release Notes) 下载 YUI 3.9.1) 并将存档中的 build 文件夹放入 my_theme/assets/yui.

构建您的文档

构建文档时,请确保指定自定义主题:

$ yuidoc my_js_folder --themedir my_theme

可能的改进

由于这会向您的项目添加一堆文件,因此深入研究 YUIDoc 并查看实际需要哪些 YUI 模块并删除其他所有内容可能是有意义的。此外,合并这些文件也是可取的(雅虎 CDN 提供的库可以做到这一点,并且应该也可以在本地运行)。