search

micrometer-metrics / micrometer-docs-generator

Apache License 2.0
9 stars 11 forks source link

Consider providing Markdown template #139

Open ciscoo opened 1 year ago

ciscoo commented 1 year ago

It would be nice if a Markdown template can be provided in addition to the Asciidoc template.

marcingrzejszczak commented 1 year ago

Here we have the templates https://github.com/micrometer-metrics/micrometer-docs-generator/tree/main/micrometer-docs-generator/src/main/resources/templates in adoc. Feel free to file a PR with a markdown version. Then it would be a matter of passing of switches at runtime to change the template https://github.com/micrometer-metrics/micrometer-docs-generator/blob/main/micrometer-docs-generator/src/main/java/io/micrometer/docs/DocsGeneratorCommand.java#L60-L82. Are you willing to file a PR? :)

ciscoo commented 1 year ago

Ideally, I would like to just say --format md or --format adoc which would set the defaults as they are now. Otherwise, I would need to specify each template individually which leads to a long command

But I think that's a separate issue/enhancement itself.

And yes, I can raise a PR. Thought to raise an issue first prior to doing any work.

marcingrzejszczak commented 1 year ago

Hmm the format thing sounds interesting. Yeah let's split the two and first see if the markdown option will work. If it will let's work on the new parameter you mentioned

github-actions[bot] commented 10 months ago

If you would like us to look at this issue, please provide the requested information. If the information is not provided within the next 7 days this issue will be closed.