search

trulia / hologram

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

index.md: a documentation error or a bug? #173

Closed chris-canipe closed 9 years ago

chris-canipe commented 9 years ago

The documentation for index in the config states:

Mark which category should be the index page Alternatively, you may have an index.md in the documentation assets folder instead of specifying this config.

However, this only works when index.md is within the source path. I also noticed that the hologram-example project is doing this: index.md is under components (source), not templates (documentation_assets).

I think the way it's documented now should be the correct behavior: I prefer having the index with the documentation assets.

Thoughts?

VikingTravis commented 9 years ago

This was also a headache for me tonight while trying to get Hologram set up.

I agree that putting index.md in the documentation_assets would be the ideal behaviour.

redoPop commented 9 years ago

Looks like this was fixed by #202.

chris-canipe commented 9 years ago

@redoPop: This was not fixed by #202, only documented.

sethwhitaker commented 8 years ago

I concur, It would be nice to be able to put the index.md in the documentation_assets folder instead of the sass source folder.

chansecampbell commented 7 years ago

Just giving this a little bump as I've just had the same issue with the index.md having to be placed within the src assets folder.