doc: Simplify the "minimum required versions" page using MyST customized URL schemes#3383
doc: Simplify the "minimum required versions" page using MyST customized URL schemes#3383
Conversation
| @@ -1,3 +1,20 @@ | |||
| --- | |||
| myst: | |||
| # Customized URI schemes that are converted to external links | |||
There was a problem hiding this comment.
Hm. Based on how I understand the documentation so far and being consistent with url_schemes:, using "URL" seem to be better, here. If we use "URI" I feel it can make sense to introduce this shortcut.
| # Customized URI schemes that are converted to external links | |
| # Customized URL schemes that are converted to external links |
There was a problem hiding this comment.
For me it seems URI is still the right term here since an URL is already a link (a location) while an URI is just the identifier that is then converted to an URL.
There was a problem hiding this comment.
The MyST documentation uses URI: https://myst-parser.readthedocs.io/en/latest/configuration.html
For the difference between URI and URL, see https://www.godaddy.com/resources/ae/skills/uri-vs-url.
I agree with @michaelgrund that URI is the right term.
There was a problem hiding this comment.
Hm, looks like the MyST documentation is not 100 % consistent here 🙃:
To specify a custom list of URL schemes, you can set the myst_url_schemes configuration option. By default this is set to ["http", "https", "ftp", "mailto"].
but at https://myst-parser.readthedocs.io/en/latest/configuration.html
myst_url_schemes | URI schemes that are converted to external links (default: {'http': None, 'https': None, 'mailto': None, 'ftp': None})
There was a problem hiding this comment.
Anyway, it's just one comment line and it doesn't hurt if it's correct or not.
There was a problem hiding this comment.
Reading https://www.godaddy.com/resources/ae/skills/uri-vs-url
URIs can be further divided into two categories: URLs and URNs. [...]
The key difference is: all URLs are URIs, but not all URIs are URLs.
So, let's keep URIs here.
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Description of proposed changes
MyST supports customized URLs.
References:
Preview: https://pygmt-dev--3383.org.readthedocs.build/en/3383/minversions.html
This page doesn't change but the markdown file is much shorter!