Skip to content

Commit 94db504

Browse files
committed
Change readme to align with previous commit
1 parent 6db225b commit 94db504

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ These are some overrides that can be used, you can actually override any tag and
7878
* `:og:type:`
7979
* Override the type of the page, for the list of available types take a look at https://ogp.me/#types.
8080
* `:ogp:image:`
81-
* Set the image for the page. Note: Relative file paths are ***not*** currently supported when using field lists.
81+
* Set the image for the page.[^1]
8282
* `:ogp:image:alt:`
8383
* Sets the alt text. Will be ignored if there is no image set.
8484

@@ -97,11 +97,11 @@ Page contents
9797
### Arbitrary Tags
9898
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:
9999

100-
Note: Relative file paths are ***not*** currently supported for images, videos and audio when using field lists.
101-
102100
```rst
103101
:og:video: http://example.org/video.mp4
104102
105103
Page contents
106104
=============
107105
```
106+
107+
[^1]Note: Relative file paths for images are currently converted to be relative to the root of the website as defined by `ogp_site_name` ***not*** the source reStructuredText file. Additionally, relative file paths for videos and audio are currently **not** supported please use an absolute path instead.

0 commit comments

Comments
 (0)