search

Doctave / doctave

A batteries-included developer documentation site generator
https://cli.doctave.com
MIT License
549 stars 33 forks source link

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

Closed CleanCodeDeveloper closed 2 years ago

CleanCodeDeveloper commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 :)