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 support for Python Markdown SuperFences #274

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

maxb2
Copy link
Contributor

@maxb2 maxb2 commented Aug 16, 2023

Fixes #281.

This supports the brace format in superfences. The blocks are processed the same as normal markdown code blocks. The only difference is the before line.

TODO

  • support more language classes (I only see .python and .py3 in the superfences docs, but there is probably more.)

@adamchainz
Copy link
Owner

So SuperFences is an extension for Python Markdown? I feel like it’s ma bit niche to add support for at this time, and more importantly commit to maintaining.

You’re free to run your fork, of course, and if others chime in saying they use this then I may be more swayed.

@adamchainz adamchainz changed the title feat: brace fences Add support for Python Markdown SuperFences Aug 16, 2023
@maxb2
Copy link
Contributor Author

maxb2 commented Aug 16, 2023

That's a fair point that it's niche.

I'll share a bit why they are useful. I'm using superfences in my own documentation as a way to pass metadata about the code block. I run the code in my markdown docs as tests (inspired by koaning/mktestdocs). The extra metadata helps control the test environment.

None of that is relevant for this project, except that I want to keep my docs formatted and need to support superfences. I thought I'd just share my work. I'll get this branch working for my own sake, but feel free to merge if you ever want to support this!

@chrimaho
Copy link

Hi @maxb2,

As requested by @adamchainz on the other issue (#281), I've tried to rebase your fork and update it so that GitHub can update this PR (#274). But it looks like I don't have access.

Message from Git when I try to do git push 👇

remote: Permission to maxb2/blacken-docs.git denied to chrimaho.
fatal: unable to access 'https://github.com/maxb2/blacken-docs/': The requested URL returned error: 403

Can you please implement the changes? Most of the changes needed should be found on my other PR (#282).

Thank you.

@maxb2
Copy link
Contributor Author

maxb2 commented Oct 14, 2024

@chrimaho @adamchainz I've rebased this onto main to prepare for merging. What else would you like to be done?

@maxb2 maxb2 marked this pull request as ready for review October 14, 2024 00:55
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.

Support Markdown fence syntax
3 participants