swift-doc icon indicating copy to clipboard operation
swift-doc copied to clipboard

Published 20 hours ago • verified publisher icon SwiftDocOrg

Incorporate README into generated HTML documentation

Open mattt opened this issue 5 years ago • 2 comments

Most projects provide a helpful overview in their README, and it'd be nice to include that in the generated HTML documentation. This requires a new, optional parameter for the generate command (defaulting to README.md) and additional design work.

mattt avatar Apr 06 '20 13:04 mattt

It would be great if there was an option not just to include README.md, but a given directory hierarchy of multiple markdown files that provide extended documentation: tutorials, guidelines, license, code of conduct etc.

MaxDesiatov avatar Apr 06 '20 13:04 MaxDesiatov

Also would be nice to have some special markdown file providing a brief introduction for the index page header.

victor-pavlychko avatar Apr 09 '20 08:04 victor-pavlychko