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 for adding and setting mkdocs style header entries #26

Open
PlasmaHH opened this issue Nov 22, 2024 · 1 comment
Open

Allow for adding and setting mkdocs style header entries #26

PlasmaHH opened this issue Nov 22, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@PlasmaHH
Copy link

I am trying to integrate sphinx based documentation into an existing mkdocs project. This extenion is getting me really far already, but there are a couple of things that could need polishing, in this issue its about the mkdocs header.

mkdocs supports a variety of header fields, all at the start of the .md file like:

Title: title as shown in the navbar
hide: toc

and it would be great if we could somehow provide this extension with a dict (or maybe a hook or so) to output these things. In my use case I would like to have the hide: toc part in every file.

The title part however would be most useful if there was some format/template thing possible so I can e.g. say title: {fullname} (or whatever the variable would be) so it creates Title: name_of_function whereas the heading is currently maybe ### name_of_function( x: str = "" ) -> None (which would be too cluttered for the title in the navbar)

@PlasmaHH PlasmaHH added the enhancement New feature or request label Nov 22, 2024
@liran-funaro
Copy link
Owner

Thank you so much for taking the time to share your feedback and suggestions!
While my bandwidth for implementing new features is limited at the moment, I truly appreciate your initiative and would be happy to review and merge a pull request if you'd like to contribute to this enhancement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants