Skip to content

Commit 4c262fd

Browse files
Reformat the readme to 80 characters
I made it using the GitHub web editor and now that I am using VS Code I can fix the formatting.
1 parent 318d2b0 commit 4c262fd

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

Diff for: readme.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# MarkDown Shortcut
22

3-
In this repository I attempt to reproduce what I think is a GitHub feature of treating a MarkDown file as a shortcut.
3+
In this repository I attempt to reproduce what I think is a GitHub feature of
4+
treating a MarkDown file as a shortcut.
45

5-
I've seen in this in the Mermaid repository here https://github.com/mermaid-js/mermaid where the `CONTRIBUTING.MD`
6-
file is "redirecting" to a nested MarkDown file whose relative path is in the main file's content, and GitHub
7-
treats this file in a special way as it has a dedicated "shortcut" icon.
6+
I've seen this in the Mermaid repository https://github.com/mermaid-js/mermaid
7+
where the `CONTRIBUTING.MD` file is "redirecting" to a nested MarkDown file
8+
whose relative path is in the main file's content, and GitHub treats this file
9+
in a special way as it has a dedicated "shortcut" icon.
810

9-
Let's see if all it takes is for a file to have a relative path of another file in its body or there is more magic
10-
to this that I am not privy to at the moment.
11+
Let's see if all it takes is for a file to have a relative path of another file
12+
in its body or there is more magic to this that I am not privy to at the moment.
1113

12-
I created two shortcut files, `shortcut.md` and `shortcut2.md`, one before the destination file existed and another
13-
after it did, however neither of them got a special icon.
14+
I created two shortcut files, `shortcut.md` and `shortcut2.md`, one before the
15+
destination file existed and another after it did, however neither of them got a
16+
special icon.
1417

15-
I am starting to think this might be a Unix thing with the file having special attributes that GitHub renders the
16-
special icon for but no other special handling.
17-
This is supported by the fact that the Mermaid MarkDown shortcut file just opens its raw content like any other
18-
MarkDown file without doing any sort of redirecting or linkifying the content path.
18+
I am starting to think this might be a Unix thing with the file having special
19+
attributes that GitHub renders the special icon for but no other special
20+
handling.
21+
This is supported by the fact that the Mermaid MarkDown shortcut file just opens
22+
its raw content like any other MarkDown file without doing any sort of
23+
redirecting or linkifying the content path.

0 commit comments

Comments
 (0)