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.

Sign up for GitHub

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

Jump to bottom

Allow Markdown fence options #246

Merged
merged 4 commits into from
Aug 16, 2023
Merged

Allow Markdown fence options #246

merged 4 commits into from
Aug 16, 2023

Conversation

maxb2
Copy link
Contributor

@maxb2 maxb2 commented May 19, 2023

MkDocs Material uses a key-value syntax after the language in a markdown fence to allow titling code-blocks. pymdownx calls these "options".

This relaxes the markdown regex to allow any text after ```python on the first line, essentially ignoring these extra options.

@dsmmcken
Copy link

+1. This is a feature I would highly support being added as well. Docusaurus has a similar feature for highlighting rows which we use for our output.

@RonnyPfannschmidt
Copy link

this looks like it needs some added tests for the functionality as well

adamchainz
adamchainz reviewed Aug 16, 2023
View reviewed changes
Copy link
Owner

@adamchainz adamchainz left a comment

Choose a reason for hiding this comment

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

Tests, readme update, changelog note all need doing. I'll add now.

src/blacken_docs/__init__.py Outdated Show resolved Hide resolved
@adamchainz adamchainz changed the title feat: allow markdown fence options Allow Markdown fence options Aug 16, 2023
@adamchainz
Copy link
Owner

I think we can skip mentioning in the readme, actually.

@adamchainz adamchainz merged commit 97aebb7 into adamchainz:main Aug 16, 2023
paddyroddy referenced this pull request in paddyroddy/python-template Aug 16, 2023
@renovate
Update pre-commit hook adamchainz/blacken-docs to v1.16.0 (#61)
d25aacc 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[adamchainz/blacken-docs](https://togithub.com/adamchainz/blacken-docs)
| repository | minor | `1.15.0` -> `1.16.0` |

Note: The `pre-commit` manager in Renovate is not supported by the
`pre-commit` maintainers or community. Please do not report any problems
there, instead [create a Discussion in the Renovate
repository](https://togithub.com/renovatebot/renovate/discussions/new)
if you have any questions.

---

### Release Notes

<details>
<summary>adamchainz/blacken-docs (adamchainz/blacken-docs)</summary>

###
[`v1.16.0`](https://togithub.com/adamchainz/blacken-docs/blob/HEAD/CHANGELOG.rst#1160-2023-08-16)

[Compare
Source](https://togithub.com/adamchainz/blacken-docs/compare/1.15.0...1.16.0)

-   Allow Markdown fence options.

Thanks to initial work from Matthew Anderson in `PR #&#8203;246
<https://github.com/adamchainz/blacken-docs/pull/246>`\__.

- Expand Markdown detection to all Python language names from Pygments:
`py`, `sage`, `python3`, `py3`, and `numpy`.

-   Preserve leading whitespace lines in reStructuredText code blocks.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;217
<https://github.com/adamchainz/blacken-docs/issues/217>`\__.

- Use exit code 2 to indicate errors from Black, whilst exit code 1
remains for “files have been formatted”.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;218
<https://github.com/adamchainz/blacken-docs/issues/218>`\__.

- Support passing the `--preview` option through to Black, to select the
future style.

-   Remove `language_version` from `.pre-commit-hooks.yaml`.
This change allows `default_language_version` in
\`\`.pre-commit-config.yaml\` to take precedence.

Thanks to Aneesh Agrawal in `PR #&#8203;258
<https://github.com/adamchainz/blacken-docs/pull/258>`\__.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/paddyroddy/python-template).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40My4yIiwidXBkYXRlZEluVmVyIjoiMzYuNDMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@maxb2
Copy link
Contributor Author

maxb2 commented Aug 16, 2023

Thanks for taking this PR the rest of the way!

paddyroddy referenced this pull request in astro-informatics/sleplet Aug 29, 2023
@renovate
Update pre-commit hook adamchainz/blacken-docs to v1.16.0 (#192)
c6dc158 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[adamchainz/blacken-docs](https://togithub.com/adamchainz/blacken-docs)
| repository | minor | `1.15.0` -> `1.16.0` |

Note: The `pre-commit` manager in Renovate is not supported by the
`pre-commit` maintainers or community. Please do not report any problems
there, instead [create a Discussion in the Renovate
repository](https://togithub.com/renovatebot/renovate/discussions/new)
if you have any questions.

---

### Release Notes

<details>
<summary>adamchainz/blacken-docs (adamchainz/blacken-docs)</summary>

###
[`v1.16.0`](https://togithub.com/adamchainz/blacken-docs/blob/HEAD/CHANGELOG.rst#1160-2023-08-16)

[Compare
Source](https://togithub.com/adamchainz/blacken-docs/compare/1.15.0...1.16.0)

-   Allow Markdown fence options.

Thanks to initial work from Matthew Anderson in `PR #&#8203;246
<https://github.com/adamchainz/blacken-docs/pull/246>`\__.

- Expand Markdown detection to all Python language names from Pygments:
`py`, `sage`, `python3`, `py3`, and `numpy`.

-   Preserve leading whitespace lines in reStructuredText code blocks.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;217
<https://github.com/adamchainz/blacken-docs/issues/217>`\__.

- Use exit code 2 to indicate errors from Black, whilst exit code 1
remains for “files have been formatted”.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;218
<https://github.com/adamchainz/blacken-docs/issues/218>`\__.

- Support passing the `--preview` option through to Black, to select the
future style.

-   Remove `language_version` from `.pre-commit-hooks.yaml`.
This change allows `default_language_version` in
\`\`.pre-commit-config.yaml\` to take precedence.

Thanks to Aneesh Agrawal in `PR #&#8203;258
<https://github.com/adamchainz/blacken-docs/pull/258>`\__.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/astro-informatics/sleplet).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40My4yIiwidXBkYXRlZEluVmVyIjoiMzYuNDMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamchainz adamchainz adamchainz left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@maxb2 @dsmmcken @RonnyPfannschmidt @adamchainz