-
-
Notifications
You must be signed in to change notification settings - Fork 10
Home
Thorsten Lorenz edited this page Dec 12, 2013
·
2 revisions
The API docs for wicked were generated using wicked itself by following these 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.md
without affecting any other links in the sidebar.
isn't it?