Skip to content

Commit f79027a

Browse files
authored
Add Codespace creation button in README.md (hellt#23)
1 parent b64d968 commit f79027a

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,20 @@ Inspired by <http://www.leancrew.com/all-this/2012/09/tidying-markdown-reference
3232
```
3333

3434
1. Or from the GitHub UI, run the container in a :sparkles:[Codespace](https://docs.github.com/en/codespaces/overview):
35+
1. With the click of a button
36+
* [![Launch in GitHub Codespaces](https://img.shields.io/badge/fnsort-Launch%20Codespace-238636?logo=github)](https://github.com/codespaces/new/hellt/markdown-footnote-sorter?devcontainer_path=.devcontainer%2Fdevcontainer.json)
37+
1. Manual steps
38+
* From this project's main page, click **Code**, then **Codespace**.
39+
* Choose **Create codespace on \<branch_name\>**
3540
36-
* From this project's main page, click **Code**, then **Codespace**.
37-
* Choose **Create codespace on &lt;branch_name&gt;**
41+
This [creates a codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)
42+
with the default resources (currently 2 CPU, 8 GB RAM, 32 GB Storage).
3843
39-
This [creates a codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)
40-
with the default resources (currently 2 CPU, 8 GB RAM, 32 GB Storage).
44+
* :rocket: Run fnsort on your markdown file:
4145
42-
* :rocket: Run fnsort on your markdown file:
43-
44-
```bash
45-
/app/fnsort.py path/to/doc.md
46-
```
46+
```bash
47+
/app/fnsort.py path/to/doc.md
48+
```
4749
4850
> [!IMPORTANT]
4951
> Keep in mind there are

0 commit comments

Comments
 (0)