Skip to content

Add badges and fix some links #351

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

Merged
merged 2 commits into from
Jul 29, 2024
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
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
![](docs/logo.png)

[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)
[![GitHub Action Status](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/actions/workflows/build.yml/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/actions/workflows/build.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab_code_formatter/master?urlpath=lab)
[![pypi-version](https://img.shields.io/pypi/v/jupyterlab-code-formatter.svg)](https://python.org/pypi/jupyterlab-code-formatter)

_A JupyterLab plugin to facilitate invocation of code formatters._

---
Expand Down Expand Up @@ -52,8 +57,8 @@ If you don't use Discord then feel free to open a [GitHub issue](https://github.

I could really use your support in giving me a star on GitHub, recommending features or fixing bugs.

- [Recommending features via GitHub Issues](https://github.com/ryantam626/jupyterlab_code_formatter/issues)
- [Submitting your PR on GitHub](https://github.com/ryantam626/jupyterlab_code_formatter/pulls)
- [Recommending features via GitHub Issues](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues)
- [Submitting your PR on GitHub](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/pulls)

---

Expand All @@ -62,8 +67,8 @@ I could really use your support in giving me a star on GitHub, recommending feat
This extension was originally developed and maintained by [@ryantam626](https://github.com/ryantam626).
Massive thanks to the below list of people who made past contributions to the project!

<a href="https://github.com/ryantam626/jupyterlab_code_formatter/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ryantam626/jupyterlab_code_formatter" />
<a href="https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/graphs/contributors">
<img src="https://contrib.rocks/image?repo=jupyterlab-contrib/jupyterlab_code_formatter" />
</a>

## License
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,13 @@ For example to override settings for the `autopep8` formatter, enter something l
:::{warning}
This plugin does not pick up file based configuration at the moment (e.g. setup.cfg, pyproject.yml, etc.)

Ticket is already opened at [#167](https://github.com/ryantam626/jupyterlab_code_formatter/issues/167).
Ticket is already opened at [#167](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues/167).
:::

:::{warning}
This plugin might be out of sync with the list of possibilities of configuration option.

See [settings.json](https://github.com/ryantam626/jupyterlab_code_formatter/blob/master/schema/settings.json) for the JSON schema used, feel free to open a PR for updating it.
See [settings.json](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/blob/master/schema/settings.json) for the JSON schema used, feel free to open a PR for updating it.
:::

## Chaining Formatters Invocation
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It is possible that black will fail when trying to create local cache directory,
python -c "import black; black.CACHE_DIR.mkdir(parents=True, exist_ok=True)"
```

For more information, see [issue #10](https://github.com/ryantam626/jupyterlab_code_formatter/issues/10).
For more information, see [issue #10](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues/10).

## JupyterLab Commands Not Showing Up

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

I am most responsive on Discord, feel free to ping me in [Python Discord](https://discord.com/invite/python), the [#editors-ide](https://discord.com/channels/267624335836053506/813178633006350366) channel is a suitable place for that.

If you don't use Discord then feel free to open a [GitHub issue](https://github.com/ryantam626/jupyterlab_code_formatter/issues), do note I am a bit slower in responding in GitHub.
If you don't use Discord then feel free to open a [GitHub issue](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues), do note I am a bit slower in responding in GitHub.
7 changes: 3 additions & 4 deletions docs/your-support.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Your Support

I could really use your support in giving me a star on GitHub, recommending features, fixing bugs or maybe even providing monetary support!
I could really use your support in giving me a star on GitHub, recommending features or fixing bugs!

- [Recommending features via GitHub Issues](https://github.com/ryantam626/jupyterlab_code_formatter/issues)
- [Sumitting your PR on GitHub](https://github.com/ryantam626/jupyterlab_code_formatter/pulls)
- [Buy me a cofee](https://www.buymeacoffee.com/ryantam626)
- [Recommending features via GitHub Issues](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues)
- [Sumitting your PR on GitHub](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/pulls)
Loading