kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat(gen_help_html): add anchors to help tags #25112

Browse Source 
Fixes #21911

Co-authored by: wispl
This commit is contained in:
Sergey Slipchenko 2023-09-12 15:51:38 +04:00 committed by GitHub
parent 7a76fb8547
commit bc67cf3ccd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
scripts/gen_help_html.lua
View File

@ -574,14 +574,15 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
return '' return ''
end end
local el = in_heading and 'span' or 'code' local el = in_heading and 'span' or 'code'
local s = ('%s<%s id="%s" class="%s">%s</%s>'):format(ws(), el, url_encode(tagname), cssclass, trimmed, el) local encoded_tagname = url_encode(tagname)
local s = ('%s<%s id="%s" class="%s"><a href="#%s">%s</a></%s>'):format(ws(), el, encoded_tagname, cssclass, encoded_tagname, trimmed, el)
if opt.old then if opt.old then
s = fix_tab_after_conceal(s, node_text(root:next_sibling())) s = fix_tab_after_conceal(s, node_text(root:next_sibling()))
end end
if in_heading and prev ~= 'tag' then if in_heading and prev ~= 'tag' then
-- Don't set "id", let the heading use the tag as its "id" (used by search engines). -- Don't set "id", let the heading use the tag as its "id" (used by search engines).
s = ('%s<%s class="%s">%s</%s>'):format(ws(), el, cssclass, trimmed, el) s = ('%s<%s class="%s"><a href="#%s">%s</a></%s>'):format(ws(), el, cssclass, encoded_tagname, trimmed, el)
-- Start the <span> container for tags in a heading. -- Start the <span> container for tags in a heading.
-- This makes "justify-content:space-between" right-align the tags. -- This makes "justify-content:space-between" right-align the tags.
-- <h2>foo bar<span>tag1 tag2</span></h2> -- <h2>foo bar<span>tag1 tag2</span></h2>
@ -963,6 +964,7 @@ local function gen_css(fname)
margin-bottom: 0; margin-bottom: 0;
} }
/* TODO: should this rule be deleted? help tags are rendered as <code> or <span>, not <a> */
a.help-tag, a.help-tag:focus, a.help-tag:hover { a.help-tag, a.help-tag:focus, a.help-tag:hover {
color: inherit; color: inherit;
text-decoration: none; text-decoration: none;
@ -977,6 +979,14 @@ local function gen_css(fname)
margin-right: 0; margin-right: 0;
float: right; float: right;
} }
.help-tag a,
.help-tag-right a {
color: inherit;
}
.help-tag a:not(:hover),
.help-tag-right a:not(:hover) {
text-decoration: none;
}
h1 .help-tag, h2 .help-tag, h3 .help-tag { h1 .help-tag, h2 .help-tag, h3 .help-tag {
font-size: smaller; font-size: smaller;
} }