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

Rendering DocLinks is fixed to the github format #3

Open
nhinze23 opened this issue Mar 15, 2023 · 0 comments
Open

Rendering DocLinks is fixed to the github format #3

nhinze23 opened this issue Mar 15, 2023 · 0 comments

Comments

@nhinze23
Copy link
Collaborator

nhinze23 commented Mar 15, 2023

Actually blocks of the documentation only support the types paragraph, code, header and list.
DocLink in paragraphs are printed in guthub format in block.go while parsing all blocks from the documentation.

To support other formats like the azure one we have either extend the parsing of the blocks to create a seperate block for a DocLink in a paragraph. With these additional blocks we can extend the doc template to use the regular formatter to render DocLink.

Or maybe we could pass the actual formatter to the parsing functionality of the paragraph and use it there.

See: Change

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

1 participant