A tool that generates github wiki compatible API documentation from your project's jsdocs and adds them to your wiki.
That is wicked!
Installation
npm install -g wicked
Usage
Steps
Create wiki by checking wiki in your project Features settings
Initialize wiki by accessing the wiki (the book icon in the navbar) which links to http://github.com/yourname/yourproject/wiki
Install wicked npm install -g wicked
Go to the root of your github project on your machine
Run wicked
Steps 4 - 5 can be repeated everytime you want to re-generate API docs for your project.
wicked does not overwrite other pages you created in your wiki so keep running wicked all you need.
More specifically wicked only removes old *.API.md files from your wiki and updates the links _Sidebar.mdwithout affecting any other links in the sidebar.
See an example of API docs added by wicked in its own wiki.
Command Line Options
usage: wicked <wicked-options> -- <jsdoc-options>
Generates wiki API docs for the gihub project in the current directory.
Both options are optional, jsdoc-options get passed to [jsdoc](http://usejsdoc.org/about-commandline.html).
Note: overriding the jsdoc destination (-d, --destination) is not possible since wicked will write files to a temp dir
OPTIONS:
--noclean don't remove the temp directory into which wiki is checked out when finished
--nocommit don't commit the updated wiki automatically nor remove the temp directory
-t, --toc causes wicked to generate a table of contents on top of each wiki page
-l, --loglevel level at which to log: silly|verbose|info|warn|error|silent -- default: info
-h, --help Print this help message.
EXAMPLES:
Generate with default options:
wicked
Generate and include table of contents:
wicked --toc
Override [jsdocconf.json](http://usejsdoc.org/about-configuring-jsdoc.html):
wicked -- --configure ./myconf.json
Override loglevel and jsoc configuration and don't remove temp directory:
wicked --loglevel silly --noclean -- --configure ./myconf.json
Helpful links and techniques
Since wicked is using jsdoc under the hood, it is helpful to review its documentation. I
highly recommendthis page explaining
how to specify @param types among other useful specs.
In order to avoid all functions being attached to the global namespace resulting in one API page per function, I namespaced functions in wicked with
@namespace and @memberof working together. As an example the Internal namespace is defined
here and used by all
the lib functions like this
one.
Feel free to study the commenting style used in wicked itself and compare with the wiki pages it produced.
Generates jsdoc wiki pages for project of current working directory and updates github wiki with them.
Note
It is assumed that this is run from the root of the project whose wiki should be generated.
Additionally the currently checked out branch will be used when generating blob urls to link source examples.
However the github remote and branch can also be set via environment vars as explained in the
documentation of jsdoc-githubify which is used
by wicked under the hood.
Parameters:
Name
Type
Description
args
Object
consumed by wicked
Properties
Name
Type
Argument
Description
noclean
Boolean
<optional>
(false) if true, the temp directory into which wiki is checked out will not be removed when done
nocommit
Boolean
<optional>
(false) if true, the updated wiki will not be committed automatically
toc
Boolean
<optional>
(false) if true, a table of contents is added to each generated wiki
loglevel
String
<optional>
(info) level at which to log: silly|verbose|info|warn|error|silent
jsdocargs
Array.<String>
consumed by jsdoc
cb
function
called back when wicked finished generating the wiki page
请发表评论