Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
contact_links:
- name: Why does Mdformat use backslash to escape my Markdown engine specific syntax? ⁉️
url: https://github.com/executablebooks/mdformat?tab=readme-ov-file#why-does-mdformat-backslash-escape-special-syntax-specific-to-mkdocs--hugo--obsidian--github--some-other-markdown-engine
url: https://github.com/hukkin/mdformat?tab=readme-ov-file#why-does-mdformat-backslash-escape-special-syntax-specific-to-mkdocs--hugo--obsidian--github--some-other-markdown-engine
about: It's likely you need to install a plugin. See the FAQ more info.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<div align="center">

[![Documentation Status](https://readthedocs.org/projects/mdformat/badge/?version=latest)](https://mdformat.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/executablebooks/mdformat/workflows/Tests/badge.svg?branch=master)](https://github.com/executablebooks/mdformat/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)
[![codecov.io](https://codecov.io/gh/executablebooks/mdformat/branch/master/graph/badge.svg)](https://codecov.io/gh/executablebooks/mdformat)
[![Build Status](https://github.com/hukkin/mdformat/workflows/Tests/badge.svg?branch=master)](https://github.com/hukkin/mdformat/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)
[![codecov.io](https://codecov.io/gh/hukkin/mdformat/branch/master/graph/badge.svg)](https://codecov.io/gh/hukkin/mdformat)
[![PyPI version](https://img.shields.io/pypi/v/mdformat)](https://pypi.org/project/mdformat)

# ![mdformat](https://raw.githubusercontent.com/executablebooks/mdformat/master/docs/_static/logo.svg)
# ![mdformat](https://raw.githubusercontent.com/hukkin/mdformat/master/docs/_static/logo.svg)

> CommonMark compliant Markdown formatter

Expand Down
4 changes: 1 addition & 3 deletions docs/contributors/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ Note that mdformat is an opinionated tool
that attempts to keep formatting style changing configuration to its minimum.
New configuration will only be added for a very good reason and use case.

Below are the basic development steps,
and for further information also see the
[EBP organisation guidelines](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md).
Below are the basic development steps.

1. Fork and clone the repository.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ contributors/contributing.md
caption: External links
hidden: true
---
GitHub repository <https://github.com/executablebooks/mdformat>
GitHub repository <https://github.com/hukkin/mdformat>
PyPI page <https://pypi.org/project/mdformat/>
```
24 changes: 12 additions & 12 deletions docs/users/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,9 @@ Note that there is currently no guarantee for a stable Markdown formatting style

- Fixed
- Warnings being printed twice when wrap mode is other than "keep"
([#167](https://github.com/executablebooks/mdformat/pull/167))
([#167](https://github.com/hukkin/mdformat/pull/167))
- An extra newline being added when consecutive lines' width equals wrap width
([#166](https://github.com/executablebooks/mdformat/pull/166))
([#166](https://github.com/hukkin/mdformat/pull/166))

## 0.6.3

Expand Down Expand Up @@ -239,23 +239,23 @@ Note that there is currently no guarantee for a stable Markdown formatting style

- Fixed
- CLI crash when formatting standard error output and the operating system reports a terminal window width of zero or less
([#131](https://github.com/executablebooks/mdformat/issues/131)).
([#131](https://github.com/hukkin/mdformat/issues/131)).
Thank you [ehontoria](https://github.com/ehontoria) for the issue.

## 0.5.6

- Changed
- Style: Reduce asterisk escaping
([#120](https://github.com/executablebooks/mdformat/issues/120))
([#120](https://github.com/hukkin/mdformat/issues/120))
- Style: Reduce underscore escaping
([#119](https://github.com/executablebooks/mdformat/issues/119)).
([#119](https://github.com/hukkin/mdformat/issues/119)).
Thank you [dustinmichels](https://github.com/dustinmichels) for the issue.

## 0.5.5

- Changed
- Style: Don't convert shortcut reference links into full reference links
([#111](https://github.com/executablebooks/mdformat/issues/111))
([#111](https://github.com/hukkin/mdformat/issues/111))

## 0.5.4

Expand Down Expand Up @@ -286,25 +286,25 @@ Note that there is currently no guarantee for a stable Markdown formatting style
- Added
- `CHANGES_AST` to extension plugin API.
The feature allows plugins that alter Markdown AST to skip validation
([#49](https://github.com/executablebooks/mdformat/pull/49)).
([#49](https://github.com/hukkin/mdformat/pull/49)).

## 0.3.2

- Changed
- Style: Keep reference links as reference links ([#32](https://github.com/executablebooks/mdformat/issues/32)).
- Style: Keep reference links as reference links ([#32](https://github.com/hukkin/mdformat/issues/32)).
Thank you [chrisjsewell](https://github.com/chrisjsewell) for the issue and the PR.
- Added
- Option to number ordered list items consecutively using the `--number` flag ([#33](https://github.com/executablebooks/mdformat/issues/33)).
- Option to number ordered list items consecutively using the `--number` flag ([#33](https://github.com/hukkin/mdformat/issues/33)).
Thank you [chrisjsewell](https://github.com/chrisjsewell) for the issue and the PR.
- Parser extension plugins can now add their own CLI / Python API options ([#35](https://github.com/executablebooks/mdformat/pull/35)).
- Parser extension plugins can now add their own CLI / Python API options ([#35](https://github.com/hukkin/mdformat/pull/35)).
Thanks [chrisjsewell](https://github.com/chrisjsewell) for the PR.
- Fixed
- Image links that require surrounding angle brackets no longer break formatting ([#40](https://github.com/executablebooks/mdformat/issues/40)).
- Image links that require surrounding angle brackets no longer break formatting ([#40](https://github.com/hukkin/mdformat/issues/40)).

## 0.3.1

- Added
- Plugin system for extending the parser ([#13](https://github.com/executablebooks/mdformat/issues/13)).
- Plugin system for extending the parser ([#13](https://github.com/hukkin/mdformat/issues/13)).
Thank you [chrisjsewell](https://github.com/chrisjsewell) for the issue and the PR.
- Exported `mdformat.renderer.MDRenderer` and `mdformat.renderer.MARKERS`

Expand Down
2 changes: 1 addition & 1 deletion docs/users/installation_and_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ mdformat.file(
Add the following to your project's `.pre-commit-config.yaml` to enable this:

```yaml
- repo: https://github.com/executablebooks/mdformat
- repo: https://github.com/hukkin/mdformat
rev: 0.7.19 # Use the ref you want to point at
hooks:
- id: mdformat
Expand Down
2 changes: 1 addition & 1 deletion docs/users/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Explore mdformat's [GitHub topic](https://github.com/topics/mdformat) for more.
<td>Changes target specification to <a href="https://myst-parser.readthedocs.io/en/latest/using/syntax.html">MyST</a></td>
</tr>
<tr>
<td><a href="https://github.com/executablebooks/mdformat-tables">mdformat-tables</a></td>
<td><a href="https://github.com/hukkin/mdformat-tables">mdformat-tables</a></td>
<td><code>tables</code></td>
<td>Adds support for GitHub Flavored Markdown style tables</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ classifiers = [
keywords = ["mdformat", "markdown", "commonmark", "formatter", "pre-commit"]

[project.urls]
"Homepage" = "https://github.com/executablebooks/mdformat"
"Homepage" = "https://github.com/hukkin/mdformat"
"Documentation" = "https://mdformat.readthedocs.io"
"Style guide" = "https://mdformat.readthedocs.io/en/stable/users/style.html"
"Changelog" = "https://mdformat.readthedocs.io/en/stable/users/changelog.html"
Expand Down
2 changes: 1 addition & 1 deletion src/mdformat/_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ def run(cli_args: Sequence[str]) -> int: # noqa: C901
"Please retry without any plugins installed. "
"If this error persists, "
"report an issue including the input Markdown "
"on https://github.com/executablebooks/mdformat/issues. "
"on https://github.com/hukkin/mdformat/issues. "
"If not, "
"report an issue on the malfunctioning plugin's issue tracker.",
],
Expand Down
4 changes: 2 additions & 2 deletions tests/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,15 @@ def test_wrap_paragraphs():
"The formatted Markdown renders to different HTML than the input Markdown. " # noqa: E501
"This is likely a bug in mdformat. "
"Please create an issue report here: "
"https://github.com/executablebooks/mdformat/issues",
"https://github.com/hukkin/mdformat/issues",
]
) == (
"Error: Could not format\n"
'"/home/user/file_name_longer_than_wrap_width--------------------------------------.md".\n' # noqa: E501
"\n"
"The formatted Markdown renders to different HTML than the input\n"
"Markdown. This is likely a bug in mdformat. Please create an issue\n"
"report here: https://github.com/executablebooks/mdformat/issues\n"
"report here: https://github.com/hukkin/mdformat/issues\n"
)


Expand Down