search

coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Other
625 stars 92 forks source link

Use codo to generate the README.md files for your github repo #177

Closed steffansluis closed 10 years ago

steffansluis commented 10 years ago

So I've searched for a while and found something about generating Github wiki pages which sounds cool as well, but much more than that I couldn't figure out. As I understand, themes are supposed to be the way to generate anything other than html, but the only theme I could find was one for YAML. Is there a way to generate Markdown and concatenate related documentation and save it to a custom location (specifically the README.md of the source dirs)? And if not, do you think it would be cool to support it?

inossidabile commented 10 years ago

Themes allow one to generate documentation in formats other than HTML. I'm not quite sure what you are trying to achieve. The resulting documentation is quite huge. I can't imagine it being one Markdown file. Tell me more about your case.

steffansluis commented 10 years ago

With Github you have the ability to browse the repository, which gives you the option of placing a README.md file in a directory and have it be rendered on Github as the README for that directory. I'd like to generate the documentation specific to each subdirectory of my src folder so that when you browse it on Github you have the docs pertaining to the files in your current directory right there.

inossidabile commented 10 years ago

This is not supported by Codo and is not currently in plans.