Skip to content

Commit 996fe87

Browse files
Update preview src for external links (#60)
1 parent 4105f6c commit 996fe87

File tree

1 file changed

+3
-20
lines changed

1 file changed

+3
-20
lines changed

preview-src/asciidoc/text-formatting.adoc

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,27 +73,10 @@ Instead of having to enclose text within <<text-formatting,tags or special chara
7373

7474
=== External link
7575

76-
External links have a special icon and open in a new tab https://www.datastax.com[when clicked^,role=external].
76+
The UI automatically applies a https://materialui.co/icon/open-in-new[special icon] to external links.
77+
(An external link is any link that doesn't target a topic on `docs.datastax.com`.)
7778

78-
[NOTE]
79-
====
80-
An _external link_ is any link that targets an address outside of the `docs.datastax.com` subdomain.
81-
External links should always have the following behavior, regardless of any AsciiDoc attributes that a writer might apply to them:
82-
83-
* Different visual styling than an internal link, e.g. an `open_in_new` icon after the link text.
84-
* Open in a new tab when clicked.
85-
86-
The links in the example sentences below all target the same external URL -- `\https://www.datastax.com` -- however, they each have different AsciiDoc attributes applied to them.
87-
88-
[source,asciidoc]
89-
----
90-
External links have a special icon and open in a new tab https://www.datastax.com[when clicked,role=external,window=_blank].
91-
External links have a special icon and open in a new tab https://www.datastax.com[when clicked^].
92-
External links have a special icon and open in a new tab https://www.datastax.com[when clicked].
93-
----
94-
95-
The UI should disregard these attributes and apply the same styling and behavior to each link.
96-
====
79+
In the rare case where you don't want the special icon to appear for a particular external link, just apply `role=remove-ext-icon` to https://materialui.co/icon/open-in-new[remove it,role=remove-ext-icon].
9780

9881
=== Unresolved link
9982

0 commit comments

Comments
 (0)