@@ -208,11 +208,31 @@ Hyperlinks
208
208
External links
209
209
~~~~~~~~~~~~~~
210
210
211
- Use ```Link text <https://domain.invalid/>`_ `` for inline web links. If the
212
- link text should be the web address, you don't need special markup at all, the
213
- parser finds links and mail addresses in ordinary text.
211
+ URLs and email addresses in text are automatically linked an do no need explicit
212
+ markup at all.
214
213
215
- .. important :: There must be a space between the link text and the opening \< for the URL.
214
+ To create text with a link, it's advisable to put the URL below the paragraph
215
+ like this (:duref: `ref <hyperlink-targets> `)::
216
+
217
+ This is a paragraph that contains `a link`_.
218
+
219
+ .. _a link: https://domain.invalid/
220
+
221
+ This keeps the paragraph more readable in source code.
222
+
223
+ Alternatively, you can embed the URL using the syntax
224
+ ```Link text <https://domain.invalid/>`__ ``
225
+ (:duref: `ref <embedded-uris-and-aliases> `).
226
+
227
+ .. important ::
228
+
229
+ There must be a space between the link text and the opening \< for the URL.
230
+
231
+ Use two trailing underscores when embedding the URL. - Technically, a single
232
+ underscore works as well, but that would create a named reference instead of
233
+ an anonymous one. Named references typically do not have a benefit when the
234
+ URL is embedded. However, they have the disadvantage that you must make sure
235
+ that you do not use "Link text" in another link in your document.
216
236
217
237
You can also separate the link and the target definition (:duref: `ref
218
238
<hyperlink-targets> `), like this::
0 commit comments