Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow custom content on homepage via meta-data (front-matter) #78

Open
froschdesign opened this issue Feb 27, 2022 · 0 comments
Open

Allow custom content on homepage via meta-data (front-matter) #78

froschdesign opened this issue Feb 27, 2022 · 0 comments
Assignees

Comments

@froschdesign
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant