Question? feature request? about README.md

jacobrask / styledocco

Automatically generate a style guide from your stylesheets.

http://jacobrask.github.com/styledocco/

MIT License

1.07k stars 119 forks source link

Question? feature request? about README.md #78

Open KrisHedges opened 11 years ago

KrisHedges commented 11 years ago

Currently the README.md file in the Project is used for the landing page of the styleguide. Is it possible to configure this to look at a different md file?

The readme isn't always the most relevant content for the styleguide and having the ability to customize that landing page would be great.

Is this just a template thing? Or could it be a config option?

marrs commented 11 years ago

Do you want to customise it to be another md page or do you want complete control over what it looks like?

KrisHedges commented 11 years ago

Oh, just to be able to point it at another md page. for the content.

marrs commented 11 years ago

@jacobrask include an --index option, default to readme.md if none is provided?

KrisHedges commented 11 years ago

+1 to that.