Type PropertyPropertyindex
indexMarkdownFilename
The standard filename for the index page introduction content.
static let indexMarkdownFilename: StringDiscussion
Place an INDEX file in the root of your package to customise the content displayed at the top of the documentation index page. This filename is chosen to avoid conflicts with:
-
Swift Package Manager (
Package,.swift README).md -
DocC (
.doccdirectories) -
Standard Git files (
README,.md CONTRIBUTING).md