Github Readmes From Repos

[esundahl]

It would be really useful to be able to add a repo to devdocs and have it import that repos Readme or have some sort of similar plugin architecture.

[Thibaut]

You mean to import the README file of other repos as a new documentation inside DevDocs? I don't think this would be very useful because the file wouldn't be indexed/searchable and the documentation would have no icon.

[esundahl]

Maybe I am in the minority but this feature would be extremely useful for me. The majority of documentation I reference comes from smaller libraries hosted on github and npm. A few examples...

https://github.com/component/dom
https://github.com/modella/modella
https://github.com/rvagg/node-levelup

I can do without an icon but most readmes are written in markdown which shouldn't be hard to parse and index. Even if importing the readme doesn't seem like the right solution some sort of ability for devdocs to import documentation from custom sources would be helpful.

[Thibaut]

Ok. I agree the ability to import documentations automatically would be useful. I may give this a try in the future but for now my focus is on adding documentations manually.

[Thibaut]

Closing this issue as I don't think it's feasible to import README files generically into DevDocs while keeping everything clean and organized.

[peteruithoven]

I would also very much like this feature. There is already a project that does this:
http://documentup.com/

Examples:
http://documentup.com/visionmedia/debug
http://documentup.com/component/dom
http://documentup.com/modella/modella
http://documentup.com/rvagg/node-levelup

The benefit is that the readability is improved and there could be a menu (generated from the headings).
Being able to store these offline would be another mayor benefit.

Maybe this can work like documentup, where you specify the target repository through the url, for example:
http://devdocs.io/github/visionmedia/debug

[Thibaut]

@peteruithoven I like that idea, especially now that we have offline mode, but probably won't get to it in the near future.