API Reference
Public APIs for @b4moss/hyogen-md. Data-source APIs are available since 0.12.0. CLI / defineConfig since 0.13.0.
| Function | Package | Description |
|---|
renderServer | @b4moss/hyogen-md | Server-side render (SSR / SSG). Accepts serverContext. |
renderClient | @b4moss/hyogen-md/client | Client-side render (CSR). Requires a custom loader. |
build | @b4moss/hyogen-md | Batch SSG — glob input, walk dependencies, write outDir. |
| Export | Package | Description |
|---|
defineConfig | @b4moss/hyogen-md/config | Typed helper for `hyogen.config.(js |
| Export | Package | Description |
|---|
createNodeLoader | @b4moss/hyogen-md | Default Node loader — local FS + remote https:// fetch. |
createFsLoader | @b4moss/hyogen-md | File-system loader only (no remote fetch). |
isRemotePath | @b4moss/hyogen-md | Utility — returns true for http:// / https:// paths. |
| Export | Package | Description |
|---|
formatDiagnosticLog | both | Format a warning or error as multi-line log text. |
formatMessage | both | Resolve a diagnostic code to an English message. |
createHyogenError | both | Construct a HyogenError with a known code. |
// Node (full surface)
import {
renderServer,
renderClient,
build,
loadDataSources,
createNodeLoader,
createFsLoader,
formatDiagnosticLog,
} from '@b4moss/hyogen-md'
// Config (CLI)
import { defineConfig } from '@b4moss/hyogen-md/config'
// Browser (client-safe subset)
import { renderClient, formatDiagnosticLog } from '@b4moss/hyogen-md/client'