search

trulia / hologram

A markdown based documentation system for style guides.
http://trulia.github.io/hologram
Other
2.16k stars 200 forks source link

Link external files into HTML-example area? #250

Open jensgro opened 9 years ago

jensgro commented 9 years ago

The documentation of HTML inside a comment of a SCSS-file is the key to many problems. Many modules are huge HTML-constructs and can be the combination of other modules. E.g. a caroussell of teasers. If the teaser changes the developer has to know, in which files this teaser is used, too.

I would prefer to link to files inside the html-example-area. In these files there would be the HTML, needed to be displayed. We would have with this solution only a singlue point of failure, regarding the working code, not multiple points.

Would this idea be possible with hologram? Would you consider developing it?

jdcantrell commented 8 years ago

I think this could be done as a custom markdown tag somehow. Personally, I'm not interested in developing but I'd be open to reviewing pull requests for it.