Skip to main content
Star us on GitHub Star

Custom components

Live showcases of the renderable components exported from @netfoundry/docusaurus-theme/ui. (For navbar items and icons see Navbar items; for search see ProductSearch.)

<Alert>​

Four type values: info, success, warning, error. Optional title.

Info alert
An informational message.
Success alert
The operation completed.
Warning alert
Heads up -- this might be an issue.
Error alert
Something failed.
No title -- just body text.

<NetFoundryHighlight>​

Wraps inline text in the brand primary color. Useful for inline emphasis.

This sentence has highlighted text in the middle.

With a custom style override:

Bold, large, primary-colored.

<NetFoundryHorizontalSection>​

A full-width horizontal section wrapper. Useful for landing-page strips.

Section heading

Content lives inside a section that spans the available width.

<DownloadSection>​

Renders OS-specific download cards with one or more architecture buttons each.

With an extra platform via extras:

Windows

FreeBSD

OpenBSD

<GitHubReleaseDownloads>​

Thin fetcher/adapter over <DownloadSection>. Resolves GitHub release assets at runtime and renders the matching platform cards. Returns null while loading or on error.

Live against openziti/ziti (stable channel). Asset names look like ziti-linux-amd64-1.6.5.tar.gz, so substring patterns are the simplest fit:

openziti/ziti-tunnel-sdk-c -- many more arches. Asset names look like ziti-edge-tunnel-Linux_x86_64.zip, so the patterns use the capitalized OS + underscore form:

<StarUs>​

Renders a "Star us on GitHub" banner that normally lives in the layout between the navbar and content. Rendered inline here for inspection only:

Star us on GitHub Star