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

New configuration option: Display the first headline in navigation menu instead of the Filename? #42

Closed
CleanCodeDeveloper opened this issue Jan 17, 2022 · 2 comments

Comments

@CleanCodeDeveloper
Copy link

First, let me start by saying thank you for this great project. It was very easy to get started. I had my first demo website generated within minutes!

However, there is one think i run into:

Would it be useful to add a configuration option to use the first markdown headline in a file instead of the filename?
image

I know that i can achieve the desired outcome by adding

---
title: My.Namespace.Test
---

on top of this each file.

My use case is the document generation for a few libraries. Unfortunately, i can not change the README.md files because there are used in different places. That's why i would prefer a configuration toggle.

@CleanCodeDeveloper
Copy link
Author

I created a build script which iterates over all markdown files, reads the first headline and inserts title yaml header into each file. Works very well for me, consider this request as solved.

Btw: doctave is really great! It was a pleasure to use, thank you!

@begleynk
Copy link
Member

Thanks for the kind words! Glad you found a solution here. I think the proper solution however is described in #32 like you also mentioned. That will be coming in a future release :)

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

No branches or pull requests

2 participants