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

feat: Add template for the confluence mermaid-cloud plugin. #285

Closed

Conversation

zopanix
Copy link

@zopanix zopanix commented Apr 4, 2023

While mark already support other mermaid plugins. This is using the free plugin from the mermaid community.

IMPORTANT NOTE: This PR is dependant on #284 as the bug was discovered while developing this feature.

While mark already support other mermaid plugins. This is using the
free plugin from the mermaid community.
README.md Outdated Show resolved Hide resolved

```mardown
<!-- Attachment: graph.mermaid -->
<!-- Macro: :mermaid:(.+):(.*):(.*)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before we start this type of workarounds with custom macros, I think it would be cleaner to have a --mermaid-provider CLI flag and render fenced codeblocks with mermaid language accordingly.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or maybe even specify MERMAID_PROVIDER via environment variables so it's easier to adjust these settings for CI/CD users

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should replace docopt-go with https://github.com/spf13/viper or similar?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I do understand these concerns. The mermaid-cloud plugin only works with attachments. We could add a dynamic attachment when we choose the mermaid provider but tbh, that might be a bit too much for me.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honnest, I don't think I have the time or capacity to develop the provider selector logic and add it in my PR. But I will be happy to re-submit a PR once it's in place with my provider. Whether you allow this to currently exists or not doesn't affect me since we'll probably maintain a fork while the above gets implemented.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! I want to work towards a PR that includes https://github.com/dreampuf/mermaid.go / #167 and will add support for multiple implementations there.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a plan, am going to close this PR and open a new one once everything is ready.

Co-authored-by: Manuel Rüger <manuel@rueg.eu>
@zopanix zopanix closed this Apr 13, 2023
@mrueg
Copy link
Collaborator

mrueg commented Apr 25, 2023

If this is still needed, I've added support for handling it via a mermaid-provider flag in #288

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

Successfully merging this pull request may close these issues.

4 participants