Skip to content

Commit 995b5b9

Browse files
authored
DOCS: Mention the mdformat GitHub topic (#450)
* Mention the mdformat GitHub topic in the docs * Format docs
1 parent 63bd6b6 commit 995b5b9

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

docs/contributors/contributing.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ setuptools.setup(
6060
)
6161
```
6262

63-
If using Poetry for packaging, the entry point configuration in `pyproject.toml` would need to be like:
63+
If using a PEP 621 compliant build backend (e.g. Flit) for packaging, the entry point configuration in `pyproject.toml` would need to be like:
6464

6565
```toml
6666
# other config here...
67-
[tool.poetry.plugins."mdformat.codeformatter"]
67+
[project.entry-points."mdformat.codeformatter"]
6868
"python" = "my_package.some_module:format_python"
6969
```
7070

@@ -112,10 +112,17 @@ setuptools.setup(
112112
If using Poetry or Flit for packaging, the entry point configuration in `pyproject.toml` would need to be like:
113113

114114
```toml
115-
# other config here...
115+
# Poetry specific:
116116
[tool.poetry.plugins."mdformat.parser_extension"]
117117
"myextension" = "my_package:ext_module_or_class"
118-
# or
119-
[tool.flit.plugins."mdformat.parser_extension"]
118+
```
119+
120+
```toml
121+
# or PEP 621 compliant (works with Flit):
122+
[project.entry-points."mdformat.parser_extension"]
120123
"myextension" = "my_package:ext_module_or_class"
121124
```
125+
126+
## Making your plugin discoverable
127+
128+
In case you host your plugin on GitHub, make sure to add it under the "mdformat" topic so it shows up on https://github.com/topics/mdformat.

docs/users/plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ formatted = mdformat.text(unformatted, codeformatters={"python"})
2323
assert formatted == '```python\n"""black converts quotes"""\n```\n'
2424
````
2525

26-
### Existing plugins
26+
### Existing plugins (see https://github.com/topics/mdformat for more!)
2727

2828
<table>
2929
<tr>
@@ -90,7 +90,7 @@ unformatted = "content...\n"
9090
formatted = mdformat.text(unformatted, extensions={"tables"})
9191
```
9292

93-
### Existing plugins
93+
### Existing plugins (see https://github.com/topics/mdformat for more!)
9494

9595
<table>
9696
<tr>

0 commit comments

Comments
 (0)