fix even more broken markdown links
Added `bin/find-missing-links.sh` tool to check for
markdown links to missing local files.
Regarding the missing link tool:
```
Here be extended regular expression magic dragons! :-)
```
Added `make find_missing_links` to the top level Makefile.
Added `make find_missing_links` to `make www` and `make quick_www`.
Ran `make www` to perform the above.
TODO: Fix markdown links to missing local files.
This commit is contained in:
1 parent
58d19725b4
commit
217836e33f
41 files changed
+1773
-635
No files matched your search
+57
-6
@@ -183,7 +183,7 @@ Use instead:
|
||||
Please do not use the tt HTML elements:
|
||||
|
||||
```html
|
||||
<tt>The HTML 5 obsolete tt element is obsolete</tt>
|
||||
<tt>The HTML 5 obsolete tt element is obsolete</tt> <=== no thank you
|
||||
```
|
||||
|
||||
Instead use either a monospaced span:
|
||||
@@ -199,6 +199,27 @@ Or better and easier still, use an inline markdown code block:
|
||||
```
|
||||
|
||||
|
||||
## Do not use un-indented code clocks
|
||||
|
||||
Please do not start code blocks at the left-hand edge.
|
||||
|
||||
````
|
||||
```
|
||||
This code block <=== no thank you
|
||||
is not indendted
|
||||
```
|
||||
```
|
||||
|
||||
We request that you indent the code block by 4 spaces:
|
||||
|
||||
````
|
||||
```
|
||||
This code block
|
||||
is intented 4 spaces
|
||||
```
|
||||
````
|
||||
|
||||
|
||||
## Do not add trailing slash on void HTML elements
|
||||
|
||||
Please do not use trailing slash on [void HTML
|
||||
@@ -251,6 +272,7 @@ Instead use just:
|
||||
|
||||
etc.
|
||||
|
||||
|
||||
## Do not end markdown links in ))
|
||||
|
||||
Please do not end a markdown links with a double closed parenthesis "))".
|
||||
@@ -261,23 +283,52 @@ to incorrect URLs or file paths.
|
||||
Instead of:
|
||||
|
||||
```
|
||||
[some text](https://example.com/foo_(bar)) <=== no thank you
|
||||
[some text](https://example.com/foo_(bar)) <=== no thank you
|
||||
```
|
||||
|
||||
Use:
|
||||
|
||||
```
|
||||
[some text](https://example.com/foo_(bar))
|
||||
[some text](https://example.com/foo_(bar))
|
||||
```
|
||||
|
||||
Instead of:
|
||||
|
||||
```
|
||||
This thing ([some text](some/path)) is not ideal. <=== no thank you
|
||||
``
|
||||
This thing ([some text](some/path)) is not ideal. <=== no thank you
|
||||
```
|
||||
|
||||
Use:
|
||||
|
||||
```
|
||||
This thing, [some text](some/path), is better.
|
||||
This thing, [some text](some/path), is better.
|
||||
```
|
||||
|
||||
|
||||
## Do not put ('s or )' markdown link titles
|
||||
|
||||
Please do not use parenthesis inside the markdown link titles.
|
||||
|
||||
Instead of:
|
||||
|
||||
```
|
||||
[some (text)](https://example.com/cyrds) <=== no thank you
|
||||
```
|
||||
|
||||
Use:
|
||||
|
||||
```
|
||||
[some (text)](https://example.com/cyrds)
|
||||
```
|
||||
|
||||
Instead of:
|
||||
|
||||
```
|
||||
[ls(1)](https://example.com/ls-man-page.1) <=== no thank you
|
||||
```
|
||||
|
||||
Use:
|
||||
|
||||
```
|
||||
[ls(1)](https://example.com/ls-man-page.1)
|
||||
```
|
||||
Reference in new issue
Block a user