• Stars
    star
    829
  • Rank 55,018 (Top 2 %)
  • Language
    CSS
  • Created about 12 years ago
  • Updated over 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

文档伴侣

Doxmate 不再为文档而发愁 Build Status

来源

过去通常要自己维护API文档,这会是一件比较蛋疼的事情。所幸我们有dox,dox可以帮我们解析注解。但是dox不能帮我们任意生成文档。于是就有了doxmate,doxmate基于dox的注解对象,加入模板。在遵循Github和CommonJS的约定后,doxmate可以帮你的模块包快速生成文档。

Installation

安装doxmate为全局工具:

$ npm install doxmate -g

Usage

此处将以doxmate项目自身作为例子:

// 签出doxmate项目
$ git clone git://github.com/JacksonTian/doxmate.git ~/git/doxmate
// 去到项目目录
$ cd doxmate
$ doxmate build
// 在docs目录下将会得到文档
$ open ~/git/doxmate/doc/index.html
// 或者 -o folder,可以将文档生成到指定的目录下
$ doxmate build -o ~/output

选择模版

// 带上-s参数后,可以选择doxmate提供的几种模板
$ doxmate build -s wordpress

自定义模版

如果doxmate提供的几个模板不能满足你的需求

// 查看doxmate目前已有的模板
$ doxmate theme list
// 在当前项目目录导出主题模板
$ doxmate theme export
// 将会在当前目录下生成{doxmate-templates/主题名}的目录
// 带上-s参数后,可以选择doxmate提供的几种模板
$ doxmate theme export -s pomelo
// 通过doxmate build创建文档的时,优先读取该目录
// 导出主题模板后,自行修改,即可实现自定义模板的目的

查看文档效果

通过将生成的文档放到gh-pages分支中,可以通过链接http://jacksontian.github.com/doxmate直接查看效果。

目前提供三种模板

默认风格

defautl 默认风格

wordpress风格

wordpress

pomelo风格

Github与CommonJS规范

  • 每个github项目下应该有一个README.md文件
  • CommonJS规范建议文档存在在doc目录下
  • CommonJS规范建议代码存在在lib目录下

Doxmate将会扫描项目下的README.md和doc目录下的md文件,通过markdown渲染,生成页面。扫描lib目录下的文件,通过dox解析内容,生成API文档页面。

贡献者

以下数据由git-summary于2012-10-27生成:

 project  : doxmate
 repo age : 11 months
 active   : 21 days
 commits  : 89
 files    : 94
 authors  : 
    71  Jackson Tian            79.8%
    10  youxiachai              11.2%
     5  Lei Zongmin             5.6%
     3  aleafs                  3.4%

License (MIT)

MIT许可,请自由享用。

Copyright (c) 2012 Jackson Tian
http://weibo.com/shyvo

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the
following conditions:

The above copyright notice and this permission notice shall be included in all copies
or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

捐赠

如果您觉得本模块对您有帮助,欢迎请作者一杯咖啡

捐赠doxmate

More Repositories

1

fks

前端技能汇总 Frontend Knowledge Structure
JavaScript
17,918
star
2

eventproxy

An implementation of task/event based asynchronous pattern.
JavaScript
2,965
star
3

anywhere

Running static file server anywhere / 随启随用的静态文件服务器
JavaScript
981
star
4

diveintonode_examples

《深入浅出Node.js》的相关代码
JavaScript
418
star
5

ping

一个您会喜欢的基于Node的Web开发框架。【学习研究所用,请勿用于生产环境】
JavaScript
387
star
6

bagpipe

Async call limit
JavaScript
320
star
7

loader

Assets loader.
JavaScript
137
star
8

api-doc-service

Node API Documentation Service
JavaScript
126
star
9

bufferhelper

Concat buffer correctly and easily.
JavaScript
122
star
10

drama

Mobile Web App startup framework/前身为V5
JavaScript
98
star
11

shenjs

深JS上的分享《Node Profiler》
JavaScript
69
star
12

jsconfcn2016

JavaScript
67
star
13

compiler

《编译原理》一书一个简单的语法制导翻译器(JavaScript版本)
JavaScript
55
star
14

ghost

Node Front-end automation test framework
JavaScript
54
star
15

httpx

http(s) module with power.
JavaScript
46
star
16

unittesting

单元测试示例模块
JavaScript
40
star
17

stone-lang

《两周自制脚本语言》学习
Java
36
star
18

para

Parallel README
JavaScript
32
star
19

diveintonode_figures

《深入浅出Node.js》书稿配图
28
star
20

using_list

What companies are using Node.js in China
28
star
21

vue2js

Compile a .vue file to .js file
JavaScript
26
star
22

dependparser

自动分析项目中的依赖项
JavaScript
25
star
23

jacksontian.github.com

My homepage http://html5ify.com
CSS
24
star
24

modulelint

modulelint检测您的模块是否优秀
JavaScript
23
star
25

markbook

用Markdown写书。
CSS
22
star
26

o_o

(o_o):HTTP/HTTPS代理工具
JavaScript
22
star
27

loader-builder

Loader's builder
JavaScript
22
star
28

limitablemap

The limitable map, for avoid memory leak issue.
JavaScript
21
star
29

boolex

Bool Expression
JavaScript
21
star
30

kimi

The Node.js client and CLI for Moonshot AI(Kimi).
JavaScript
20
star
31

diveintonode_site

《深入浅出Node.js》书稿配套网站
18
star
32

slidemate

JavaScript
17
star
33

node_ci

A NodeJS MVC Framework (Like CodeIgniter).
JavaScript
15
star
34

ipod

ipod
JavaScript
15
star
35

sync_package

Sync NPM package from remote registry to local.
JavaScript
14
star
36

itodo

TODO list
JavaScript
14
star
37

plusplus

I need a better Underscore in Node.js
JavaScript
13
star
38

re-captcha

recaptcha验证码中间件
JavaScript
13
star
39

doxco

Documentation generator, docco for dox
CSS
13
star
40

waterfall

See Demo http://jacksontian.github.com/waterfall/
JavaScript
12
star
41

nounou

Node.js process deamon.
JavaScript
12
star
42

spritemate

Sprite Mate
JavaScript
12
star
43

tensorflow-node

JavaScript
10
star
44

fawave_mobile

JavaScript
10
star
45

kitx

A Node.js toolkit.
JavaScript
10
star
46

memeda

JavaScript
9
star
47

leakchecker

A tool for check the memory leak.
JavaScript
9
star
48

jsconfcn2017

8
star
49

gesture

触屏手势库,基于Winter和Zepto.js完成
JavaScript
8
star
50

nodejsctl

Shell
8
star
51

yixin

易信公众平台SDK(Node)。请右转使用微信模块:
8
star
52

dingbot

DingTalk Group Bot for Node.js
JavaScript
8
star
53

landscape

Tiny front-end framework.
JavaScript
7
star
54

eventbase

EventBase
JavaScript
7
star
55

hitaxi

我要叫车 [我要车-乘客][我有空-司机]
JavaScript
7
star
56

ebnf-parser

JavaScript
6
star
57

v

可视化资料库
5
star
58

hookx

Hook(x) with Power.
JavaScript
5
star
59

nakupenda

Learning OS
C
5
star
60

loader-connect

Loader middleware for connect
JavaScript
5
star
61

pool

Pool Stream
JavaScript
5
star
62

forward

Forward request
JavaScript
5
star
63

iquery

select('*').from('table').where('1 = 1').groupBy('column').orderBy('count DESC').limit(0, 100)
JavaScript
5
star
64

skyline

JavaScript
5
star
65

_footprint

A JavaScript template
JavaScript
4
star
66

context-ex

Context Expression
JavaScript
4
star
67

alpha

Node API search
JavaScript
4
star
68

mah-jong

JavaScript
4
star
69

JacksonTian

3
star
70

protobuf2

JavaScript
3
star
71

writing

Press markdown
CSS
3
star
72

v5_weibo

JavaScript
3
star
73

iwalk

Walk dictionary
JavaScript
3
star
74

V5UI

UI widget library
JavaScript
3
star
75

loader-koa

Loader for Koa
JavaScript
3
star
76

streamx

Ultimate stream for ES6
JavaScript
3
star
77

gyp_mirror

Python
3
star
78

readx

Read stream like sync call
JavaScript
3
star
79

rtf-parser

Rich Text Format
3
star
80

tinywork

Just do a little tiny work for Promises
JavaScript
3
star
81

gocov

A better test coverage reporter than go tool cover.
JavaScript
3
star
82

panel

一个可以替代iScroll的面板
JavaScript
2
star
83

Understanding-Computation

《计算的本质》学习
JavaScript
2
star
84

elemento

WebComponent
JavaScript
2
star
85

suncity

LBS App. Build with NodeJS & MongoDB. Named as SunCity.
JavaScript
2
star
86

math_for_kids

数学学习小项目。
HTML
2
star
87

cpu_alert

高 CPU 占用进程告警器
JavaScript
2
star
88

node-webdav-client

CalDAV client
JavaScript
2
star
89

gogo

HTML
2
star
90

footprint

A very very small logger.
JavaScript
2
star
91

columnpress

Markdown blog
Smarty
2
star
92

tallybook

我的记账本应用
JavaScript
2
star
93

user-agent

User Agent String for mock client
JavaScript
2
star
94

tiny-function

JavaScript
2
star
95

julia-set

JavaScript
1
star
96

doxmategen_site

Used host doxmate documents
HTML
1
star
97

koa-forward

forward for koa
JavaScript
1
star
98

arch_mate

JavaScript
1
star
99

little.js

http://www.crockford.com/javascript/little.html
JavaScript
1
star
100

super-init-myegg

JavaScript
1
star