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: README.md
+6-2Lines changed: 6 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ Users hosting documentation on Read The Docs *do not* need to set any of the fol
28
28
*`ogp_site_name`
29
29
* This is not required. Name of the site. This is displayed above the title.
30
30
*`ogp_image`
31
-
* This is not required. Link to image to show.
31
+
* This is not required. Link to image to show. Note that all relative paths are converted to be relative to the root of the html output.
32
32
*`ogp_image_alt`
33
33
* This is not required. Alt text for image. Defaults to using `ogp_site_name` or the document's title as alt text, if available. Set to `False` if you want to turn off alt text completely.
34
34
*`ogp_use_first_image`
@@ -78,7 +78,7 @@ These are some overrides that can be used, you can actually override any tag and
78
78
*`:og:type:`
79
79
* Override the type of the page, for the list of available types take a look at https://ogp.me/#types.
80
80
*`:ogp:image:`
81
-
* Set the image for the page.
81
+
* Set the image for the page. Note: Relative file paths are ***not*** currently supported when using field lists.
82
82
*`:ogp:image:alt:`
83
83
* Sets the alt text. Will be ignored if there is no image set.
84
84
@@ -92,12 +92,16 @@ Remember that the fields **must** be placed at the very start of the file. You c
92
92
93
93
Page contents
94
94
=============
95
+
```
95
96
96
97
### Arbitrary Tags
97
98
Additionally, you can use field lists to add any arbitrary OpenGraph tag not supported by the extension. The syntax for arbitrary tags is the same with `:og:tag: content`. For Example:
98
99
100
+
Note: Relative file paths are ***not*** currently supported for images, videos and audio when using field lists.
0 commit comments