Kramdown's table row validator only runs its :codespan and :span_html parsers (not :escaped_chars), so the backslash-escaped backtick in [\`define macros](#defines) opened an unclosed code span across the row's | delimiter and caused Kramdown to abort parsing the table. Wrap `define in a two-backtick inline code span so Kramdown renders the table, and drop the duplicate #sequential-logic anchor above #sequential-logic-registers.
This doesn't directly support zippies, but it's needed in cases where
guides use <div> blocks as the first zippy element. For now, it should
be a noop.
This resyncs the vim guide to the latest (with most zippies removed)
and replaces the manual Python TOC with an automatic one like most of
the other guides.
Convert the Hoedown multiline naming-overview table into a standard single-line Markdown table so Kramdown renders it as an HTML table instead of a definition list. Disambiguate colliding heading anchors and wrap macro references in inline code spans.
Rouge on GitHub Pages only registers its SystemVerilog lexer under 'verilog' and does not recognize 'systemverilog', causing Kramdown to emit bare <pre><code> blocks without syntax or Good/Bad highlighting.
Workaround for #1050
This is a port of the existing styleguide.js auto TOC logic from the
HTML guides to the newer markdown guides. Rather than generate the
entire TOC in JS, rely on GH's generator to create, and then process
it slightly with minimal CSS+JS.
While GH's builtin markdown renderer automatically creates sidepanel
TOCs, the GH pages export does not. Use the `* TOC {:toc}` form so
the export automatically generates for us. The downside is that it
also shows up in GH's builtin markdown renderer, but it's only one
line at the top, so it shouldn't be onerous.
The CSS logic tweaks which levels are displayed in the generated
TOC: we hide the single top-level, and omit levels deeper than 2.
The JS logic puts the TOC into a <details> HTML element (internally
called a zippy) so that it's collapsed by default.
While the old auto TOC codebase supported "horizontal" and "vertical"
formats, the new one only supports "vertical". Most of our guides do
not care and take the default since that's what internal & external
markdown renderers use, but notably some are using horizontal still:
* C++, HTML/CSS, Java, JS, TS: external, but not internal
* shell: internal & external (via manual TOC)
We'll leave the shell guide alone, but the rest will be switched over
in the future as we regenerate things, and discuss with respective
maintainers.
We've merged/migrated existing users over to javaguide.css now,
so there's no need for it anymore. Let's clear the space so we
can rename the mdguide stuff in the future.
`:help functions()` is not a valid help tag and fails with
"E149: Sorry, no help for functions()". Point to `:help function-list`
instead, which lists the built-in functions grouped by purpose.
Every other HTML guide switched to javaguide.css, so move C++ too.
This also fixes good code styling in all HTML pages, and fixes C++
code syntax colorization.
Lubaba Khalid