https://github.com/jdf2e/jdd

jdf组件文档生成工具
https://github.com/jdf2e/jdd

Last synced: 5 months ago
JSON representation

jdf组件文档生成工具

• Host: GitHub
• URL: https://github.com/jdf2e/jdd
• Owner: jdf2e
• Created: 2017-07-31T10:38:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-14T10:28:12.000Z (almost 9 years ago)
• Last Synced: 2025-10-02T17:37:12.173Z (8 months ago)
• Language: HTML
• Size: 30.3 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# jdd

js文档，demo和说明文档快速生成

## 安装

```javascript

npm install jddx -g

```

## 使用

```javascript

 Command:

    -b,--build  	build project

    -w,--watch  	watch current , build project

    -v      	jdd version

```

## 目录结构

```

demo/ demo文件目录

js/ js文件目录

doc/ 说明文件目录

changelog.md

readme.md

package.json

```

## 配置详解

```json

{

	"name": "myjs",  //工程名

	"version": "1.0.0", //版本号

	"author": "fe", //作者

	"api": {

		"name": "jds api", //js api工程名,会显示api首页

		"description": "" //js api工程描述,同样会显示在api首页

	},

	"apisource":"js/", //js目录

	"demosource":"demo/", //demo目录

	"demoExclude":"demoExcludeDir", //demo目录过滤

	"docsource":"doc/", //说明文档目录

	"target":"docs/", //生成到目录

	"demopathprefix":"../", //demo页导航url前缀

	"stat":"" //统计代码

	"extendHtml":"",//在页面最底部增加额外的html片断

	"copyright":"",//底部版权信息

	"extendMenu":{

		"http://a.com":"这是站点a", //导航上增加额外的链接

		"http://b.com":"这是站点b"

	}

}

```

## 建议package.json源文件

可直接复制后生成package.json

```json

{

	"name": "myjs",

	"version": "1.0.0",

	"author": "fe",

	"api": {

		"name": "jds api",

		"description": ""

	},

	"apisource":"js/",

	"demosource":"demo/",

	"docsource":"doc/",

	"target":"docs/",

	"demopathprefix":"../",

	"copyright":"Copyright © 2015 xxx All Rights Reserved"

}

```