Skip to content

Commit b2d1490

Browse files
authored
Include a dev container for this project (hellt#15)
1 parent c136da4 commit b2d1490

File tree

2 files changed

+24
-9
lines changed

2 files changed

+24
-9
lines changed

.devcontainer/devcontainer.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"image": "ghcr.io/hellt/markdown-footnote-sorter:latest",
3+
"features": {
4+
}
5+
}

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ of the file.
99

1010
Based on <https://github.com/derdennis/sort-markdown-footnotes>
1111

12+
Inspired by <http://www.leancrew.com/all-this/2012/09/tidying-markdown-reference-links/>
13+
1214

1315

1416
https://github.com/user-attachments/assets/2ccb1782-1d85-499c-ba09-3be94c34a591
@@ -17,19 +19,27 @@ https://github.com/user-attachments/assets/2ccb1782-1d85-499c-ba09-3be94c34a591
1719

1820
## How to use?
1921

20-
You can use the container image provided:
22+
1. You can use the container image provided:
23+
24+
```bash
25+
docker run --rm -v $(pwd):/work ghcr.io/hellt/markdown-footnote-sorter path/to/doc.md
26+
```
27+
28+
1. Or download the script and put it in your `$PATH`:
2129

22-
```bash
23-
docker run --rm -v $(pwd):/work ghcr.io/hellt/markdown-footnote-sorter path/to/doc.md
24-
```
30+
```bash
31+
curl -sL https://raw.githubusercontent.com/hellt/markdown-footnote-sorter/main/fnsort.py
2532
26-
Or download the script and put it in your `$PATH`:
33+
fnsort.py path/to/doc.md
34+
```
2735

28-
```bash
29-
curl -sL https://raw.githubusercontent.com/hellt/markdown-footnote-sorter/main/fnsort.py
36+
1. Or run the container in a [Codespace](https://docs.github.com/en/codespaces/overview):sparkles: via the GitHub UI:
37+
* From this project's main page, click **Code**, then **Codespace**.
38+
* Choose **Create codespace on <branch_name>** to [create a codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository) with the default resources (currently 2 CPU, 8 GB RAM, 32 GB Storage).
39+
<img alt="create codespace button" title="create codespace button" src="https://docs.github.com/assets/cb-49943/mw-1440/images/help/codespaces/who-will-pay.webp" width="275px"/>
3040
31-
fnsort.py path/to/doc.md
32-
```
41+
> [!IMPORTANT]
42+
> Keep in mind there are [monthly limits measured in core hours](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts) and to [stop your codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace):stop_sign: when you're not using it to conserve your monthly core hours allowance.
3343

3444
## Command Line Arguments
3545
### --adjacent

0 commit comments

Comments
 (0)