Plugins add behavior to the build process or the generated site. Sarde ships
with 27 built-in plugins, and sites can install external plugins into their
plugins/ directory.
Read Using Plugins for enable/disable configuration,
plugin options, lifecycle hooks, and page injection rules. Read
External Plugins for installing and managing
plugins distributed outside the Sarde binary, and
Premium Plugins for licensed ones.
Server-side plugins run during sarde build and produce files or inject
metadata: Search, SEO,
Sitemap, Feeds,
Social Cards, SlideViewer,
Link Validator,
and Content Lint.
Client-side plugins inject JavaScript and CSS into the generated pages:
Reading Progress,
Scroll to Top,
Image Lightbox,
Focus Mode,
External Links, and more.
Using Plugins
Enable, disable, and configure Sarde's built-in server-side and client-side plugins
External Plugins
Install, enable, and configure declarative plugins packaged outside the Sarde binary
Premium Plugins
License premium external plugins with offline, signed license files
Copy Section Link
Copy a shareable link to a heading section by clicking its anchor icon
External Links
Mark external links with an arrow icon and open them in a new browser tab
Focus Mode
Hide the sidebar and table of contents for distraction-free reading
Image Lightbox
Open content images in a full-screen overlay with zoom and pan controls
Keyboard Nav
Navigate between previous and next pages using the arrow keys, with optional side navigation arrows
Last Updated
Show a badge with the page's last-modified time, relative or absolute
Reading Position Memory
Remember a reader's scroll position and offer to restore it on return
Reading Preferences
Let readers adjust font, size, spacing, alignment, and content width
Reading Progress
Show a scroll progress bar and an estimated reading time badge
Scroll to Top
A floating button that scrolls back to the top, with an optional progress ring
Search Highlighter
Highlight search terms on the page when readers arrive from site search
Text Highlighter
Let readers highlight text passages, persisted across visits via localStorage
Announcements
Render dismissible announcement banners with scheduling and page targeting
Content Lint
Catch heading, alt-text, link, and frontmatter quality issues during the build
Feeds
Generate RSS 2.0 and Atom 1.0 feed files for feed-enabled collections
KaTeX
Ship KaTeX runtime assets to pages that contain math markup
Link Validator
Check internal links, anchors, and image references during the build
LLMs.txt
Generate an llms.txt file listing every content page for LLM discovery
Mermaid
Ship Mermaid runtime assets to pages that contain diagram markup
Redirects
Generate redirect files from page aliases and global redirect mappings
Robots
Generate a robots.txt file that allows all crawlers and links the sitemap
Search
Build a JSON search index at build time with embedded, offline Orama search
SEO
Inject Open Graph, Twitter Card, and JSON-LD structured data into every page
Sitemap
Generate a sitemap.xml listing every non-draft page with metadata
Social Cards
Auto-generate Open Graph social card images for pages without one
SlideViewer
Ship the SlideViewer presentation runtime to pages using the presentation layout