How to generate Programming Guides with Appledoc

appledoc is a pretty awesome tool. It’s a command line tool that generates a very Apple-like documentation for your Objective-C projects. The documentation is a little short on details and isn’t clear if you can also create Apple-like Programming Guides or documentation pages decoupled from code. Well guess what? You can! And with Markdown support, which makes the whole thing even more awesome.

How do you do it then?

It’s pretty straightforward, you just need to create Markdown files, suffixed with -template.md and add a --include instruction in your appledoc call as in:

appledoc ... --include my-first-template.md --include My\ Second-template.md ...

Now, visit your index.html and you’ll get a new links section at the bottom of the page called Programming Guides!

Random Notes