Feature request: Allow overriding base header levels for embedded about gomarkdoc HOT 2 OPEN

This is an interesting suggestion. The ability to customize the level feels particularly useful for embedding scenarios, especially since the levels are mostly hardcoded right now and would have to be changed in multiple places.

A couple questions:

• Do you need the ability to use different levels for each embed or is a CLI parameter sufficient if it applies the same to all levels?
• Any reason not to simply omit the header and import by customizing the template(s)? I can potentially split the header into its own template like the import is now, but the behavior you're asking for feels more appropriate for the template than as a bespoke parameter. If you want to run embedded and non-embedded scenarios through the same configuration, the tool could provide some sort of isEmbedded function so you can vary the behavior

from gomarkdoc.

• Do you need the ability to use different levels for each embed or is a CLI parameter sufficient if it applies the same to all levels?

My primary use case is embedding in the repo root readme, so really only one level is sufficient. Including the docs in pkg/blah/ readmes would probably warrant multiple levels if they were rendered out simultaneously.

• Any reason not to simply omit the header and import by customizing the template(s)? I can potentially split the header into its own template like the import is now, but the behavior you're asking for feels more appropriate for the template than as a bespoke parameter. If you want to run embedded and non-embedded scenarios through the same configuration, the tool could provide some sort of isEmbedded function so you can vary the behavior

I think I looked at this and decided it wouldn't be trivial, but it's been long enough that I don't recall. Our use case is targeting a pre-commit hook to ensure the docs are always up to date in the codebase across many Go repos, so we were hoping for a standard/cli solution that didn't involve external resources, e.g. a customized template.

from gomarkdoc.