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

Dealing with triple-backslash-mermaid vs. triple-backslash-{mermaid} #150

Closed
Tracked by #14
cclauss opened this issue Sep 5, 2024 · 1 comment
Closed
Tracked by #14

Comments

@cclauss
Copy link
Contributor

cclauss commented Sep 5, 2024

The triple-backslash-mermaid syntax works in a README.md file on GitHub (see image below).

```mermaid
Content
```
What is the most convenient and reliable way to add the required braces in the sphinx-build process?
```{mermaid}
Content
```

   sequenceDiagram
      participant Alice
      participant Bob
      Alice->John: Hello John, how are you?
      loop Healthcheck
          John->John: Fight against hypochondria
      end
      Note right of John: Rational thoughts <br/>prevail...
      John-->Alice: Great!
      John->Bob: How about you?
      Bob-->John: Jolly good!
Loading
@cclauss
Copy link
Contributor Author

cclauss commented Sep 6, 2024

Fixed by adding myst_fence_as_directive = ["mermaid"] to conf.py as discussed at

@cclauss cclauss closed this as completed Sep 6, 2024
@cclauss cclauss changed the title Adding the required braces to triple-backslash-mermaid when sphinx-building gh-pages Dealing with \\\mermaid vs. \\\{mermaid} Sep 6, 2024
@cclauss cclauss changed the title Dealing with \\\mermaid vs. \\\{mermaid} Dealing with ``\\\mermaid vs. \\\{mermaid}`` Sep 6, 2024
@cclauss cclauss changed the title Dealing with ``\\\mermaid vs. \\\{mermaid}`` Dealing with \\\\\\\\\mermaid vs. \\\\\\\\\{mermaid} Sep 6, 2024
@cclauss cclauss changed the title Dealing with \\\\\\\\\mermaid vs. \\\\\\\\\{mermaid} Dealing with mermaid vs. {mermaid} Sep 6, 2024
@cclauss cclauss changed the title Dealing with mermaid vs. {mermaid} Dealing with triple-backslash-mermaid vs. triple-backslash-{mermaid} Sep 6, 2024
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

2 participants
@cclauss and others