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

Add the markdown-svgbob extension #181

Open
2 tasks
llucax opened this issue Nov 24, 2023 · 0 comments
Open
2 tasks

Add the markdown-svgbob extension #181

llucax opened this issue Nov 24, 2023 · 0 comments
Assignees
Labels
part:mkdocs Affects the configuration of mkdocs type:enhancement New feature or enhancement visitble to users
Milestone

Comments

@llucax
Copy link
Contributor

llucax commented Nov 24, 2023

What's needed?

We need to render ASCII-art diagrams and graphs more nicely in the documentation.

Proposed solution

Add the markdown-svgbob extension.

TODO

  • Add the extension
  • Add the bob code block file type to any ASCII-art in the repo

Use cases

Be able to have diagrams / graphs that are readable both as text (when looking at docstrings in IDEs) and look nice in HTML documentation.

Alternatives and workarounds

No response

Additional context

PR adding this to Channels:

@llucax llucax added type:enhancement New feature or enhancement visitble to users part:mkdocs Affects the configuration of mkdocs labels Nov 24, 2023
@llucax llucax added this to the v0.8.0 milestone Nov 24, 2023
@llucax llucax self-assigned this Nov 24, 2023
@llucax llucax modified the milestones: v0.8.0, v0.9.0 Dec 18, 2023
@llucax llucax modified the milestones: v0.9.0, v0.10.0 Feb 20, 2024
@llucax llucax modified the milestones: v0.10.0, v0.11.0 Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:mkdocs Affects the configuration of mkdocs type:enhancement New feature or enhancement visitble to users
Projects
Status: To do
Development

No branches or pull requests

1 participant