Skip to content

Commit cb4aa28

Browse files
committed
Added a tip about using the new "check-external-links.sh" script.
Signed-off-by: Dean Wampler <dean.wampler@ibm.com>
1 parent aad05c0 commit cb4aa28

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README-template.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This repo contains the code and documentation for the AI Alliance: "_MICROSITE_TITLE_".
66

7-
See the [documentation](https://the-ai-alliance.github.io/REPO_NAME/) for a more detailed description of the project.
7+
See the [repo README](https://the-ai-alliance.github.io/REPO_NAME/) for additional details about this project.
88

99
## Quick Tip - View the Website Locally
1010

@@ -69,7 +69,9 @@ For external links, add a `target` tag using the following syntax, which works f
6969
[title]({{site.baseurl}}/relative_URL){:target="_target"}
7070
```
7171

72-
The `target` value is arbitrary; use whatever you want. While this is a little more tedious to type, it is usually better for users so they don't lose their place in the document. Also, [our stylesheet](https://github.com/The-AI-Alliance/REPO_NAME/blob/main/docs/_includes/css/custom.scss.liquid) is configured to put the little up-and-to-the-right arrows after every link that isn't relative, i.e., links that start with `http` or `https`. This provides a visual clue that a new tab will be opened.
72+
The `target` value is arbitrary; use whatever you want. While this is a little more tedious to type, it is usually better for users so they don't lose their place in this site. Also, [our stylesheet](https://github.com/The-AI-Alliance/REPO_NAME/blob/main/docs/_includes/css/custom.scss.liquid) is configured to put the little up-and-to-the-right arrows after every link that isn't relative, i.e., links that start with `http` or `https`. This provides a visual clue that a new tab will be opened.
73+
74+
> **TIP:** There is a script included in the repo, `check-external-links.sh`, that will look for external URLs that are missing the `{:target="foo"}` annotations.
7375
7476
#### Emojis
7577

0 commit comments

Comments
 (0)