Is it possible to post the documentation to Github Wiki pages? #290

Closed
adamdahan opened this Issue Dec 19, 2012 · 6 comments

Projects

None yet

3 participants

@adamdahan

I am looking for a small script that will help me publish the generated documentation to my githubs wiki pages

@tomaz
Owner
tomaz commented Dec 19, 2012

It's possible and I saw something along the lines somewhere, but don't remember the link... Will update if I remember.

@adamdahan

I actually found it! All I need to do is generate markdown files... but I am still unsure how to do this after researching the site + external examples... is there a line I can add to my script to generate markdown files?

@tomaz
Owner
tomaz commented Dec 19, 2012

You probably think about "static" documentation - i.e. companion guides? You should create these files yourself and tell appledoc the path, then it will include them automatically when building output.

@tomaz
Owner
tomaz commented Dec 22, 2012

The only additional cmd line switch is --templates with which you specify
the path to your custom templates. Other than that, you probably don't want
to generate docset. Then change the html templates so that they product
Markdown instead of html.

Tom

@tomaz
Owner
tomaz commented May 17, 2013

Closing this ticket in attempt to cleanup stuff a bit :) Don't hesitate to comment or reopen it in case of further development!

@tomaz tomaz closed this May 17, 2013
@mralexgray

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment