Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

Incorporate README into generated HTML documentation #57

Open
mattt opened this issue Apr 6, 2020 · 2 comments
Open

Incorporate README into generated HTML documentation #57

mattt opened this issue Apr 6, 2020 · 2 comments
Labels
enhancement New feature or request
Projects
SwiftDoc
Milestone
1.1.0

Comments

@mattt
Copy link
Contributor

mattt commented Apr 6, 2020

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 mattt added the enhancement New feature or request label Apr 6, 2020
@MaxDesiatov
Copy link
Contributor

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.

@mattt mattt mentioned this issue Apr 6, 2020
Open
@mattt mattt added this to To do in SwiftDoc Apr 6, 2020
@victor-pavlychko
Copy link
Contributor

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

This was referenced Apr 9, 2020
Merged
Open
@mattt mattt added this to the 1.0.0-beta.5 milestone Jul 31, 2020
@mattt mattt modified the milestones: 1.0.0-beta.5, 1.0.0-beta.6 Sep 25, 2020
@mattt mattt modified the milestones: 1.0.0-beta.6, 1.1.0 Mar 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
SwiftDoc
  
To do
Milestone
1.1.0
Development

No branches or pull requests
3 participants
@mattt @MaxDesiatov @victor-pavlychko