Home

Thorsten Lorenz edited this page Dec 12, 2013 · 2 revisions
Clone this wiki locally

Wicked

The API docs for wicked were generated using wicked itself by following these steps:

  1. Create wiki by checking wiki in your project Features settings
  2. Initialize wiki by accessing the wiki (the book icon in the navbar) which links to http://github.com/yourname/yourproject/wiki
  3. Install wicked npm install -g wicked
  4. Go to the root of your github project on your machine
  5. 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.

Wicked!

isn't it?