Version warning banner: inject on role="main" or main tag #8079
Conversation
stsewd
force-pushed
the
more-general-version-banner
branch
from
9e03f59
to
0c77197
Compare
| body = $("div.document"); | ||
| var selectors = ['[role=main]', 'main', 'div.body', 'div.document']; | ||
| for (var i = 0; i < selectors.length; i += 1) { | ||
| var body = $(selectors[i]); |
There was a problem hiding this comment.
Were we ok using let instead of var? Or there was some browser compatibility we were worried about?
There was a problem hiding this comment.
FWIW, if we're using let, we should also use it (and const) as much as possible.
There was a problem hiding this comment.
We should keep it the same as the existing code, to keep things consistent. Then we can change it up when we decide to at the project level.
| @@ -145,7 +145,23 @@ you can enable it in the admin section of your docs (:guilabel:`Admin` > :guilab | |||
|
|
|||
| .. note:: | |||
|
|
|||
| This feature is available only for :doc:`Sphinx projects </intro/getting-started-with-sphinx>`. | |||
There was a problem hiding this comment.
I put this, but I was wrong, thought we injected this from our extension, but this is just JS from the footer. Well, it wasn't a complete lie, since isn't common in mkdocs themes to have div.body or div.document p:
| var selectors = ['[role=main]', 'main', 'div.body', 'div.document']; | ||
| for (var i = 0; i < selectors.length; i += 1) { |
There was a problem hiding this comment.
I think we should copy these lines to the sphinx-version-warning extension. Currently, it only uses one selector and the user can change it via a config, but I suppose we could try these same different selectors by default: https://github.com/humitos/sphinx-version-warning/blob/master/versionwarning/_static/js/versionwarning.src.js#L21
There was a problem hiding this comment.
Ref pradyunsg/sphinx-basic-ng#12