NiroHelp adds three reader-facing extras to docs: syntax highlighting for code,
click-to-zoom on images, and automatic links on headings.
Syntax-highlighted code blocks #
Wrap code in the [nirohelp_code]] shortcode and say which language it is:
[[nirohelp_code lang="php"]]
your code here
[[/nirohelp_code]
The language defaults to php. Any common language name works — js, ts, css,
html, bash, json, yaml, sql, python, go, ruby, rust and the rest.
Your code is displayed exactly as written, and line breaks the visual editor
added are cleaned up first, so pasted code survives.
The block editor’s own Code block is not highlighted. It produces a plain
code block with no language attached, so it renders unstyled. Use the shortcode
when you want colours.
Image zoom #
Images inside a doc’s body are made clickable automatically: clicking one opens
it full size in a lightbox, and clicking outside or pressing Esc
closes it. Images you have already linked to something else are left alone, so
a screenshot that links somewhere keeps its link.
There is no setting for this. Turning it off needs a developer.
Heading links #
On a single doc, each heading gets a small # link beside it, so readers can
copy a link straight to a section.
On docs written in the block editor, headings usually do not get one. The
feature only recognises plain headings, and the block editor adds styling
information to every heading it produces. Headings written in the classic
editor do get their links.
If you rely on links to specific sections, write those headings in the classic
editor, and check the published page before you announce the link.
Featured image #
The featured image appears in the docs archive and at the top of the doc
itself. NiroHelp does not set the image used when someone shares your doc on
social media — that comes from whichever SEO plugin you run, reading the same
featured image.
A note on page weight #
The syntax-highlighting files load on every page of your site, not only on
docs. If page weight matters to you, a developer can limit them to doc pages.
The image-zoom files load on single docs only.
Was this doc helpful?