trulia / hologram

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

Add support for overriding supported extensions #196

Closed fatastronauts closed 9 years ago

fatastronauts commented 9 years ago

I have really been enjoying Hologram a lot. One minor gripe I am having is with the files that are parsed. I would like to block sub directories or have hologram ignore .scss files. I have a few factory functions that generate classes and their markdown. When Hologram sees the function that generates the markdown it is parsing that function and either throwing an error or adding the function into the style guide which looks broken to users.

Could you add support for removing a supported extension or blocking a subdirectory?

jdcantrell commented 9 years ago

We've discussed adding an ignore config option for files and directories that would take care of this. At this time though it's still on the todo list.

vegetabill commented 9 years ago

:+1: to this. We're monkey patching '.rb' into the extensions at the moment.

jdcantrell commented 9 years ago

You should be able to do this now:

ignore_paths:
  - "ruby_codes/*"
  - my_file.scss
fatastronauts commented 9 years ago

Thank you @jdcantrell this was very helpful.