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

Consider providing Markdown template #139

Open
ciscoo opened this issue Aug 24, 2023 · 4 comments
Open

Consider providing Markdown template #139

ciscoo opened this issue Aug 24, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@ciscoo
Copy link

ciscoo commented Aug 24, 2023

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

@marcingrzejszczak
Copy link
Contributor

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

@marcingrzejszczak marcingrzejszczak added the enhancement New feature or request label Aug 24, 2023
@ciscoo
Copy link
Author

ciscoo commented Aug 24, 2023

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
Copy link
Contributor

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

Copy link

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.

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