The content of the homepage is created automatically.
The site_name and the site_description from the MkDocs configuration file are used, the links of the support section are hardcoded.
But custom content can also be added. This can be configured via a configuration entry in the mkdocs.yml file but it would be more intuitive to insert this directly into the related file.
Current Usage
mkdocs.yml
extra:
show_special_homepage: true
https://github.com/laminas/tutorials/blob/a3f59c7466391e8a09786d3708d4a66c00f37ddd/mkdocs.yml#L43-L44
Preferred Usage
index.md:
---
allow_custom_content: true
---
# Custom Content
…
https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data
The content of the homepage is created automatically.
The
site_nameand thesite_descriptionfrom the MkDocs configuration file are used, the links of the support section are hardcoded.But custom content can also be added. This can be configured via a configuration entry in the
mkdocs.ymlfile but it would be more intuitive to insert this directly into the related file.Current Usage
mkdocs.ymlhttps://github.com/laminas/tutorials/blob/a3f59c7466391e8a09786d3708d4a66c00f37ddd/mkdocs.yml#L43-L44
Preferred Usage
index.md:https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data