2014-01-17 17 views
3

JSDoc輸出在每一頁的頁腳日期:偶可引起JsDoc3省略<footer>標籤與它的日期?

<footer> 
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Fri Jan 17 2014 14:30:54 GMT-0800 (PST) 
</footer> 

所以每當我重建我的圖書館,所有的文檔文件看起來他們已經改變了對Git的。這是不可取的 - 我只希望當他們在內容上真正改變提交這些文檔。

偶可引起JsDoc到輸出頁腳中呢?

回答

3

我有創造jsdoc 3個模板一些微薄的經驗,我已經看過了代碼來檢查你的要求。以下是我發現:

  • <footer>在默認模板的文件layout.tmpl硬編碼。通過硬編碼的,我的意思是元素本身是不可選的。

  • 我還沒有看到默認模板的publish.js文件中的任何代碼在處理layout.tmpl時會以某種方式刪除<footer>

所以要消除這種頁腳,你不得不使用定製的模板或3.3.0之前做一些對jsdoc 3

產生隨着版本的文件後處理,去除<footer>從模板將意味着複製整個默認模板,並進行更改,以layout.tmpl。 3.3.0版本,這是目前在阿爾法,will provide the possibility基本上告訴jsdoc 3使用默認的模板,但有不同的layout.tmpl文件,這將使自定義模板要容易得多。

4

我爲此問題提交了一個PR(https://github.com/jsdoc3/jsdoc/pull/916),它現在在3.3.0分支上。

這種變化是在沒有發佈到NPM在我寫這個答案的時候,但你可以從需要混帳3.3.0分支:

"jsdoc": "git+https://[email protected]/jsdoc3/jsdoc.git#releases/3.3" 

之後,您可以在以下字段添加到您的配置文件:

{ 
    ... 
    "templates": { 
     ... 
     "default": { 
      "includeDate": false 
     } 
    }, 
    ... 
} 

注意此選項僅適用於默認jsdoc模板。