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

时间:2015-01-19 16:29:56

标签: yui yuidoc

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

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

1 个答案:

答案 0 :(得分:5)

我遇到了同样的问题,我真的不明白为什么没有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.zipRelease Notes)下载YUI 3.9.1,并将build文件夹从存档中放到my_theme/assets/yui

构建文档

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

$ yuidoc my_js_folder --themedir my_theme

可能的改进

由于这会为您的项目添加大量文件,因此深入了解YUIDoc并查看实际需要哪些YUI模块并删除其他所有内容可能是有意义的。此外,组合文件是可取的(从雅虎的CDN服务的图书馆这样做,并且应该可以在本地工作)。