Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
yui-jsdoc
Advanced tools
Javascript Document & Demo builder (base on smartDoc and YUIDoc and bootstrap 3).
Weekly downloads
Readme
# 默认情况下就是根目录的docConfig.js
yuiJsDoc --config `path to your config file`
基于smartDoc + YUIDoc构建的Javascipt文档生成器。
由于原来smartDoc模块作者迟迟不更新issue,遂基于它做了二次开发。
详细介绍见我的博客: JS文档和Demo自动化生成工具 - SmartDoc和注释编写说明
license : BSD
* 加入@demo配置项,看可以动态抓取html和js的内容作为@example,同时支持扩展@demo读取
* 支持jasmine测试js文件的单元代码抓取为@example
* 实现多个example显示和tab切换
* 加入@show配置项来控制直接显示example效果
* 主题改版
* 去除@attribute属性设置,统一使用@property
* 基于Bootstrp3构建,排版和样式美化
* 支持html和js的Demo生成,与查看
* 提供在线的demo编辑页面(类似于jsfiddler)
* 同步jasmine的expect接口,使得单元测试与example的代码能够复用
* 可以配置化增强 - 项目信息配置;Document页面导航配置;demo依赖库配置
* 提供全局api查询和导航过滤功能,筛选更加便利
* 提供grunt插件 - grunt-contrib-smartdoc
在目录中加入docConfig.js文件
npm install -g smartdoc
smartdoc
module.exports = {
//扫描的文件路径
paths: ['input/code/'],
//demo读取路径
demoDir:"input/demo/",
//文档页面输出路径
outdir: 'doc/',
//项目信息配置
project: {
//项目名称
name: 'SmartDoc',
//项目描述,可以配置html,会生成到document主页
description: '<h2>SmartDoc</h2> <p>Javascript Document builder base on YUIDoc.</p>',
//版本信息
version: '1.1.0',
//地址信息
url: 'https://github.com/zhh77/smartjs',
//logo地址
logo : 'https://github.com/zhh77/logo.png',
//导航信息
navs: [{
name: "Home",
url: "https://github.com/zhh77/smartjs"
}, {
name: "Document",
url: ""
}, {
name: "About",
url: "https://github.com/zhh77/smartjs"
}]
},
//demo展示页面配置;需要加载的资源; 资源只能是css和js文件
demo: {
//外部资源链接
link : ['http://code.jquery.com/jquery-1.11.0.min.js'],
//文件复制路径; 将目下的资源复制到doc生成目录中,并在deom页面引用
paths : ['input/code/ui/uicode.js','input/'],
//是否开启在code编辑器中的自动完成功能(会将link和paths的引入加入);默认开启;
autoComplete : true
},
//自定义主题路径
themedir: 'theme/',
//自定义helpers
helpers: ["theme/helpers/helpers.js"]
};
其他使用见 YUIDoc
将代码下载后,运行
npm install
node test.js
程序会将input/目录下的js扫描,将Document生成到doc/目录下,运行doc/index.html,即可访问生成的文档。
注意:生成后的代码编辑页面需要发布到服务器才能正常运行;
FAQs
Javascript Document & Demo builder (base on smartDoc and YUIDoc and bootstrap 3).
The npm package yui-jsdoc receives a total of 1 weekly downloads. As such, yui-jsdoc popularity was classified as not popular.
We found that yui-jsdoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.