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

why should plantuml be quoted in plantuml! instead of plantuml ? #70

Open
zhangfuwen opened this issue Dec 23, 2021 · 2 comments
Open
Assignees
Labels
good first issue Good for newcomers

Comments

@zhangfuwen
Copy link

the trailing ! is in compliant with markdown previewers in visual studio code.

@jeffreytse jeffreytse self-assigned this Dec 23, 2021
@jeffreytse jeffreytse added the good first issue Good for newcomers label Dec 23, 2021
@jeffreytse
Copy link
Owner

Hi @zhangfuwen

This design is to distinguish between code blocks and render blocks, especially when you want to show the code and the render result at the same time.

Thanks and Regards

@qurm
Copy link

qurm commented Sep 26, 2022

I see the same issue with mermaid! and plantuml! and the usage without the ! is a standard in VS Code previewers, and in Github readme.md. This is really a major drawback for anyone working with Markdown in those tools.

There are plenty of alternatives to showing a code block for mermaid and plantuml, that are really only plain text.

The workaround for me is to add the section below to my _config.yml with code: 'mermaid'. This restores to the expected behaviour, but seems like a bad UX to have to make this change.

jekyll-spaceship:
  mermaid-processor:
    mode: default  # mode value 'pre-fetch' for fetching image at building stage
    css:
      class: mermaid
    syntax:
      code: 'mermaid'
      custom: ['@startmermaid', '@endmermaid']
    config:
      theme: default
    src: https://mermaid.ink/svg/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants