You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/link-previews.rst
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,26 @@ so you can keep your context while reading but learn more from other resources.
10
10
11
11
Example of link previews addon
12
12
13
+
Link previews will only be generated for internal links--links that point to pages within your documentation site.
14
+
No link previews will be generated for links to external sites or links that appear outside of the primary content of the documentation page (eg. nav bars).
13
15
16
+
You can see an example of a link preview by hovering over the following link: :doc:`Addons </addons>`.
14
17
15
18
Enabling link previews
16
19
----------------------
17
20
18
-
In your dashboard, you can go to the links preview tag in :guilabel:`Settings > Addons > Link previews` and enable it.
21
+
#. Go to the new :term:`dashboard`.
22
+
#. Click on a project name.
23
+
#. Go to :guilabel:`Settings`, then in the left bar, go to :guilabel:`Addons`.
24
+
#. Go to :guilabel:`Link previews` and check :guilabel:`Enabled`.
25
+
#. Save your settings -- a rebuild of your project isn't required!
19
26
20
27
Troubleshooting link previews
21
28
-----------------------------
22
29
23
30
We perform some heuristic to detect the documentation tool used to generate the page based on its HTML structure.
24
31
This auto-detection may fail, resulting in the content rendered inside the popup being incorrect.
25
-
If you are experimenting this, you can specify the CSS selector for the main content in :guilabel:`Settings > Addons > Advanced`,
32
+
If you are experiencing this, you can specify the CSS selector for the main content in :guilabel:`Settings > Addons > Advanced`,
26
33
or you can `open an issue in the addons repository <https://github.com/readthedocs/addons>`_ so we improve our heuristic.
34
+
35
+
Link previews won't be generated if JavaScript is not enabled in your web browser or if all cookies are blocked.
0 commit comments