簡體   English   中英

如何使用離線資源構建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的文件從原始主題復制到main.handlebars my_theme/layouts/文件夾。 如果您通過節點安裝了YUIDoc,則原始文件位於node_modules/yuidocjs/themes/default/layouts/ 或者,您可以從yuidoc GitHub倉庫中獲取它。

在該文件中進行以下更改:

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.)從雅虎的CDN中獲取CSS

從Yahoo CDN下載cssgrids-min.css並將其放入my_theme my_theme/assets/css文件夾中。

2.)下載YUI 3.9.1庫

http://yui.zenfs.com/releases/yui3/yui_3.9.1.zip發行說明 )下載YUI 3.9.1,並將存檔中的build文件夾放到my_theme/assets/yui

建立你的文檔

構建文檔時,請確保指定自定義主題:

$ yuidoc my_js_folder --themedir my_theme

可能的改進

由於這會為您的項目添加一堆文件,因此深入了解YUIDoc並查看實際需要哪些YUI模塊並刪除其他所有內容可能是有意義的。 此外,組合文件是可取的(從雅虎的CDN服務的圖書館這樣做,並且應該可以讓它在本地工作)。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM