search

jbt / docker

Documentation generator
http://jbt.github.com/docker
MIT License
233 stars 56 forks source link

Can .css and .jade files be included? #28

Closed aeife closed 11 years ago

aeife commented 11 years ago

I want to generate a documentation for my node.js express application. But unfortunatly it doesnt include files like css or jade template files. Is there a way to include them in the generated documentation?

jbt commented 11 years ago

Shouldn't be too hard - the main problem with CSS is that it doesn't have any inline comments, only block comments, and the way things are written at the moment it can't cope with that.

Jade should be possible but coping with block comments might not be possible as they're whitespace-dependent so there's no end-comment delimiter.

I'll take a look and see what I can come up with

aeife commented 11 years ago

Ok thanks. For my uses it would even be enough to just view the files content via the documentation. I dont have any comments in my css or jade files but just want a complete view for all project code. At the moment this is possible by renaming all not supported files to .js and after that rename them in doc-filelist.js and the html-file itself. But its much work to do when there are lots of those files. It would be nice if any filetype would be supported at least with just a view of their content.

imanen-bryan commented 11 years ago

Support for LESS would also be great, but I don't think pygments support LESS. Also, +1 for the idea of simply allowing all unsupported files to be loaded into docker with their source displayed.

jbt commented 11 years ago

Thanks to the work of @mikkel jade support should now work, and I've also added CSS support in. As for the two other suggestions here (support of LESS and inclusion of unsupported files) - I'll create them as separate new issues now