Skip to content

Commit 0aa4ed2

Browse files
authored
Update Readme including capitalizing Markdown (hellt#25)
* Capitalize Markdown in README.md Capitalize instances of the word Markdown that are _not_ part of hyperlinks. * Adjust md alert regarding core hours in README.md
1 parent 3b68c54 commit 0aa4ed2

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# markdown-footnote-sorter
22

3-
A script to sort footnotes in a markdown file.
3+
A script to sort footnotes in a Markdown file.
44

55
Reads a Markdown file passed as the first argument and sorts footnotes.
66
The reference links will be numbered in
@@ -41,7 +41,7 @@ Inspired by <http://www.leancrew.com/all-this/2012/09/tidying-markdown-reference
4141
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)
4242
with the default resources (currently 2 CPU, 8 GB RAM, 32 GB Storage).
4343
44-
* :rocket: Run fnsort on your markdown file:
44+
* :rocket: Run fnsort on your Markdown file:
4545
4646
```bash
4747
/app/fnsort.py path/to/doc.md
@@ -50,10 +50,9 @@ Inspired by <http://www.leancrew.com/all-this/2012/09/tidying-markdown-reference
5050
> [!IMPORTANT]
5151
> Keep in mind there are
5252
> [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)
53-
and to
54-
[stop your codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)
55-
:stop_sign: when you're not using it to conserve your monthly core hours
56-
allowance.
53+
> and to [stop your codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)
54+
> :stop_sign: when you're not using it to conserve your monthly core hours
55+
> allowance.
5756

5857
## Command Line Arguments
5958

@@ -70,7 +69,7 @@ identified during sorting.
7069

7170
Retain or keep inline reference and footnote names.
7271
This prevents the default behavior of replacing the names with numbers.
73-
Footnotes at the end of the markdown are **still sorted**.
72+
Footnotes at the end of the Markdown are **still sorted**.
7473

7574
`fnsort.py path/to/doc.md --keepnames`
7675

0 commit comments

Comments
 (0)