Library documentation URL helpers.
Runtime UI helpers for building URLs in the library documentation system. These depend on fuz_ui's documentation paths and SvelteKit's runtime state.
For generic package/repository URL helpers, see package_helpers.ts.
5 declarations
library_helpers.ts view source
(declaration_name: string): string Build project-relative API documentation URL with hash anchor.
declaration_nameName of the declaration to link to
stringstring URL path like '/docs/api#declaration_name'
library_helpers.ts view source
(homepage: string, declaration_name: string): string Build full API documentation URL with domain and hash anchor.
homepagePackage homepage URL
stringdeclaration_nameName of the declaration to link to
stringstring Full URL like 'https://example.com/docs/api#declaration_name'
library_helpers.ts view source
(module_path: string): string Build project-relative module documentation URL.
module_pathModule path (e.g., 'helpers.ts')
stringstring URL path like '/docs/api/helpers.ts'
library_helpers.ts view source
(homepage_url: string | null, logo_path?: string | undefined): string | null Build package logo URL with favicon.png fallback.
homepage_urlPackage homepage URL, or null
string | nulllogo_path?Optional custom logo path (defaults to 'favicon.png')
string | undefinedstring | null Full URL to the logo, or null if no homepage
library_helpers.ts view source
(url: string, origin?: string): string Convert a full URL to root-relative format by removing the origin.
Uses SvelteKit's page state for the current origin by default.
urlFull URL to convert
stringoriginOrigin to strip (defaults to current page origin)
stringpage.url.originstring Root-relative URL starting with '/'
// Assuming page.url.origin is 'https://example.com' url_to_root_relative('https://example.com/docs/api') // => '/docs/api'