search

killercup / grock

Grock converts your nicely commented code into a gorgeous documentation where comments and code live happily next to each other.
http://killercup.github.io/grock/
MIT License
38 stars 13 forks source link

Any issues running it on browser? #13

Closed SridharSubramaniam closed 9 years ago

SridharSubramaniam commented 10 years ago

Hi,

Since there is no pygments dependency, can it run on browser with marked and highlights js ?

-Sridhar

killercup commented 10 years ago

That's a good question. I guess in some way or another, you might get it to work using something like browserify.

Most grock components should work with little to no adjustments. What I imagine might cause some trouble are external dependencies like vinyl-fs (file representation, all transforms depend on this), pretty-hrtime (measure run time, nice-to-have) and chalk (colorful console output, nice-to-have).

If I wanted to do this, I would probably start with duplicating the lib/generator.coffee file, removing all nice-to-have requirements, and replacing vinyl-fs with a custom handler for my file representation.

It might also be tricky to get the styles to work since they are dynamically loaded (but I guess that's optional as well, you could start with a fixed default style).

SridharSubramaniam commented 10 years ago

Thanks for the quick response. I will try it out.

killercup commented 10 years ago

Cool! I'll leave this issue open so you can post your findings and/or problems you encounter.

killercup commented 9 years ago

Did you pursue this? I'll just close this issue for now. Feel free to open new ones for bugs or specific features you'd like to see :)