{"_id":"hexo-yuidoc","_rev":"35-35801b308b501427722e024ff2f2fd06","name":"hexo-yuidoc","dist-tags":{"latest":"0.2.2"},"versions":{"0.0.1":{"name":"hexo-yuidoc","version":"0.0.1","keywords":["hexo","yuidoc","api"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENS","type":"MIT"},"_id":"hexo-yuidoc@0.0.1","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"93dd549a2af7cf6fdc84b1290da6c3efafc5d31d","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.0.1.tgz","integrity":"sha512-b4SMTtIsqqoQT5BZ1GzVLwC6azpu5H+qw/XAmgcSk0uTKBzWspjIxJcmBYTGTyvGXjyOVk2FG/g6DwIiiI4mkw==","signatures":[{"sig":"MEUCIQC6HIiNz9AkEvHd60VjlrgeP8ZI1tg4PJy2aX6G7X8IhwIgGKtFwcsKWv1TojSYBQN376ik9sn1RxSufabbLEFQijs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.3.14","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"swig":"0.14.0","lodash":"2.4.0"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.0.2":{"name":"hexo-yuidoc","version":"0.0.2","keywords":["hexo","yuidoc","api"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.0.2","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"52909bd732fed3a4c7d75906f2b1799327bf4aea","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.0.2.tgz","integrity":"sha512-MNSjdxKo1BNSOFPCeborXYJO1T2dfKYxdJ9SGbGb2BUGjVf3a429oTjdS1e/SMtOLU0zW0570k5WklC9C25aMQ==","signatures":[{"sig":"MEUCIQCXKHxtLZz8JZhKJliKOD0QpBFV63Nb/L5P21DXEMhGiwIgK9dNPOkhDjDdFJTU5SSN12tnKlW7mj0iM6OcUouinGo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"0.2.10","lodash":"2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.0.3":{"name":"hexo-yuidoc","version":"0.0.3","keywords":["hexo","yuidoc","api"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.0.3","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"96f36c3e3cd2457101580af0163e22adcac84503","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.0.3.tgz","integrity":"sha512-ewtv1diSzBJD1rPw9qCF2PbsZcw8+Od+qDCAoQAkcd/MY0DBuBVkSRnAXrCOxslY01SInsPln8pbVOx+HyvRzA==","signatures":[{"sig":"MEQCIA8l9WhMTOGHyggSBR26SmrZZMO4zDE/JUuNmiV2zXgeAiA2G1wI1qwFJ6Wix0Ugg+RBxTO6JPak5hQ3sUjwe26Gpg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"0.2.10","lodash":"2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.1.0":{"name":"hexo-yuidoc","version":"0.1.0","keywords":["hexo","yuidoc","api","generator"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.1.0","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"600db2971aba0d1a1f49d8a46c8e6a01bb472400","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.1.0.tgz","integrity":"sha512-m5hyOsT/1CWTDGkw0Yh3Hv/iExAd7QBp+EZt6HaQ++SZ+vtkvEhXK8NTI7f9lv3sxGAABB6gdq9a8mWGxdyTPg==","signatures":[{"sig":"MEQCIBOVhFzafsy7jAxQ5NfYnPSeR4AaTg34fODuPIHv0r4EAiBX4RfOSdaah1sUQuqrVamEZZfl23o/6IQE36LTJenInw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"^0.8.0","lodash":"^2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.1.1":{"name":"hexo-yuidoc","version":"0.1.1","keywords":["hexo","yuidoc","api","generator"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.1.1","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"06dda8ca5567a76e0a0d8ed5f13411a2fe2135ab","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.1.1.tgz","integrity":"sha512-KVB1VuPr0+FVIw7uBn+6Ay89tBjcLuadEKZ6pocB916aXmtQ0MJBObVQSf49j+GJOY/jhOA0ApKf962OD0aVWg==","signatures":[{"sig":"MEUCIGd1AsgyF7RS92GB4DlZ0XbGwRjo7xq4PeAFMT5qa3KZAiEA7pjMusor/GLgK5gHyY6uN0U9aEK5PpUQ0l9PecoAN/Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"^0.8.0","lodash":"^2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.0":{"name":"hexo-yuidoc","version":"0.2.0","keywords":["hexo","yuidoc","api","generator"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.2.0","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"e4404d05b339163684c490d839994d67d53be40c","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.2.0.tgz","integrity":"sha512-b3FEWDYtSD6POGPDeaaQG+DbfJ9lSY/eRVrGalk8MvK5Fjsmnb03d/KtAWrSReRJI5GTVT1me+Rgu6jnejakPA==","signatures":[{"sig":"MEUCICmNl3OkgHlP03nvgwpSel/LlPZSe93mmTEMZ+7YRbtsAiEAjtHcPgMaahPK3/2mXAtegWFB3mX3UEZyurxYgMVwEh8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"^0.8.0","lodash":"^2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.1":{"name":"hexo-yuidoc","version":"0.2.1","keywords":["hexo","yuidoc","api","generator"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.2.1","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"e5f1aa9ce6407ae8aed3cb96df7d19d5d9909b2e","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.2.1.tgz","integrity":"sha512-rZubcXniCg0uFaeHmlR797JZGU7Tj50fjc56rGxkDVaxgChbwJsCmsiq4N/JxQmo4CHEMcNaL7HtpHuXnnoxsw==","signatures":[{"sig":"MEQCIHLiajOyKMBWyhdPjsR9Y2oK9snOSnZThV+SHm7Dt38eAiBfMIqzFDFrckHkg+hDcxbTnA0LKdQDQ3IrFP74wIj3Cg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"^0.8.0","lodash":"^2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.2":{"name":"hexo-yuidoc","version":"0.2.2","keywords":["hexo","yuidoc","api","generator"],"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"_id":"hexo-yuidoc@0.2.2","maintainers":[{"name":"tommy351","email":"tommy351@gmail.com"}],"homepage":"https://github.com/hexojs/hexo-yuidoc","bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"dist":{"shasum":"ea7350cfc769eb917dda1b24429ae3da772559ea","tarball":"https://registry.npmjs.org/hexo-yuidoc/-/hexo-yuidoc-0.2.2.tgz","integrity":"sha512-MwJe8Z7ta2wOnYJIz16Jgn1ChTCn/3sby2axrSfyRdPJuFOfrAgXiqTKY9j6EMtGz+PHiLWvt+D57axonPsH/w==","signatures":[{"sig":"MEUCIBopr/sYXFDYl6KKnY/SY1AH3WjsqQwHsm5UknAuD6aFAiEAr+Wx6JhdwAnuoZec/3rKqu+PkdUaK0qJsItyR5tkWaE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/index","_from":".","_npmUser":{"name":"tommy351","email":"tommy351@gmail.com"},"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"_npmVersion":"1.4.3","description":"YUIDoc generator for Hexo","directories":{"lib":"./lib"},"dependencies":{"async":"^0.8.0","lodash":"^2.4.1"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2014-01-14T09:00:10.249Z","modified":"2026-05-16T02:39:57.249Z","0.0.1":"2014-01-14T09:00:12.311Z","0.0.2":"2014-03-13T09:17:26.303Z","0.0.3":"2014-03-14T06:29:04.281Z","0.1.0":"2014-05-10T04:22:23.973Z","0.1.1":"2014-05-17T14:20:02.386Z","0.2.0":"2014-07-10T16:28:44.427Z","0.2.1":"2014-07-11T17:31:13.586Z","0.2.2":"2014-07-12T01:20:18.434Z"},"bugs":{"url":"https://github.com/hexojs/hexo-yuidoc/issues"},"author":{"url":"http://zespia.tw","name":"Tommy Chen","email":"tommy351@gmail.com"},"license":{"url":"https://raw.github.com/tommy351/hexo/master/LICENSE","type":"MIT"},"homepage":"https://github.com/hexojs/hexo-yuidoc","keywords":["hexo","yuidoc","api","generator"],"repository":{"url":"https://github.com/hexojs/hexo-yuidoc.git","type":"git"},"description":"YUIDoc generator for Hexo","maintainers":[{"name":"abnerchou","email":"hi@abnerchou.me"},{"name":"jlhwung","email":"jlhwung@gmail.com"},{"name":"tomap","email":"piartt@gmail.com"},{"name":"tommy351","email":"tommy351@gmail.com"},{"name":"yoshinorin","email":"yoshinorin.net@outlook.com"}],"readme":"# YUIDoc\n\nGenerate [YUIDoc] with Hexo.\n\n## Install\n\n``` bash\n$ npm install hexo-yuidoc --save\n```\n\n## Usage\n\n### Requirements\n\nYou have to install [YUIDoc] first.\n\n``` bash\n$ npm install yuidocjs -g\n```\n\n### Generating\n\nGenerate raw data with YUIDoc first. Then, move `data.json` to `source/_yuidoc` folder. You can rename `data.json` to whatever you like. For example:\n\n```\nindex.json => /api/classes/Class.html\nfoo.json => /api/foo/classes/Foo.html\n```\n\n### Templates\n\nYou have to at least add two templates to the `layout` folder of the theme:\n\n- `api/class`\n- `api/module`\n\nYou can get the model from `site.yuidoc` and get the name of current yuidoc from `page.yuidoc_name` in templates.\n\n### Helpers\n\n#### yuidoc_type\n\nGets the link of specified data types. You can use a string or an array. Multiple types will be separated by `|`. Besides classes in the database, you can also use [native types](https://github.com/hexojs/hexo-yuidoc/blob/master/lib/helpers.js#L11).\n\n```\n<%- yuidoc_type('String') %>\n<%- yuidoc_type(['String', 'Array']) %>\n```\n\n#### yuidoc_params\n\nGenerates a parameter list.\n\n```\n<%- yuidoc_params(params) %>\n```\n\n#### get_current_yuidoc\n\n```\n<% get_current_yuidoc() %>\n```\n\n### Tags\n\nYou can use all tags and filters in your documentation.\n\n#### crosslink\n\nYou can use `crosslink` to cross-reference other classes.\n\n```\n{% crosslink class/item:[type] [link text] %}\n```\n\n## Options\n\nYou can configure this plugin in `_config.yml`.\n\n``` yaml\nyuidoc_dir: api\n```\n\n- **yuidoc_dir** - Where generated files will be saved (Default: api)\n\n[YUIDoc]: http://yui.github.io/yuidoc/","readmeFilename":"README.md"}