YUIDocのmarkdownとか設定のいろいろ

markdownを使う

YUIDocは説明部分をマークダウンで記述することができる。

/**
* [see this](http://www.mamoida.com/)
*
* ```
* parseHoge('number',15);
* ``` 
* 
* @method parseHoge
* @param {String} name
* @param {String | Number} value
*/

yuidoc.jsonのmarkdownオプションにはmarkedへのオプションを渡すことができる。

GitHub flavored markdownを無効にしたり。

yuidoc.json

"options": {
  "markdown": {
    "gfm" : false
  }
}

サニタイズを有効にしたり。

yuidoc.json

"options": {
  "markdown": {
    "sanitize" : true
  }
}

スタンドアロン・サーバ

yuidocはスタンドアロンのサーバがついていて、オプションを付けてコマンドをたたくと起動する。
ポート番号も指定できる。

yuidoc --server 5000

ポート番号5000に立ち上がる。デフォルトは3000。

テーマを指定する

simpleとdefaultというビルドインテーマがあるので、特にこだわらなければ--themeオプションでどちらかを指定する。(指定しなければdefault)

yuidoc --server 5000 --theme simple

カスタマイズしたものを使うときは、起動時に--themedirオプションでテーマディレクトリへのパスを渡すか、yuidoc.jsonにパスを記述することでテーマを指定することができる。

テンプレートはHandlebarsテンプレートが使用されている。

yuidoc.json

"options": {
  "themedir": "themes/custom/",
}

ビルドインテーマはGitHubで公開されている。カスタムテーマを作るならこれを元にするといい感じ。ドキュメントはこちら。

Gruntに組み込む

grunt-contrib-yuidocを使う

npmでインストール。

npm install grunt-contrib-yuidoc --save-dev

設定はyuidoc.jsonと同じなので、階層が同じであればyuidoc.jsonを読み込むだけでいい。

Gruntfile.js

  yuidoc: {
    build: grunt.file.readJSON('yuidoc.json')
  },

おしまい