Option to add project README.md to the output?

[metasoarous]

Using the README as a start for documentation output could be nice for intro content. Is this out of scope?

[gdeer81]

Most people link to their marginalia documentation in their README so I would be worried about creating an endless loop where the marg docs references the README and the README references the marg docs.

[metasoarous]

This doesn't seem too worrisome to me. To be clear, what I'm describing is not just an automatic link to the README, but insertion of the README as content within the documentation. So the net effect would really just be that the documentation has some link in it that points to the documentation. Again, that doesn't seem to be too big a deal to me. Plenty of web pages have links to themselves, and as silly as it may be, it doesn't feel as silly to me as copying and pasting a bunch of explanatory README text over into my core api namespace as a way of introducing the library.

Obviously, this won't make sense for every situation, so it should probably be an opt-in thing. But I'm sure that I would use this, and I imagine there are others for whom it would make sense as well.

[jjl]

+1 from me here. I want precisely the described behaviour of embedding the README.md (in html form) at the beginning of the marginalia output.

[abhishiv]

I'm currently using a custom shell script to run lein marg .. and then patch toc.html. However I would still think it makes sense to have it included in marginalia.

Like metasoarous, I wouldn't be too worried about circular referencing, specially because most probably it would be optional.