pppaths

package
v0.0.78 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 18, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ExtHTML     = ".html"
	ExtJSON     = ".json"
	ExtMarkdown = ".md"

	// DirStatic is the renderer's embedded shared-asset tree. Files under
	// DirStatic are global to a build (JS bundle, CSS, fonts, icons) and are
	// served by the host at a single URL prefix; they are never written per
	// artifact.
	DirStatic   = "static"
	DirFonts    = "fonts"
	DirShoelace = "shoelace"
	DirAssets   = "assets"
	DirIcons    = "icons"

	DirOperations = "operations"
	DirModels     = "models"
	DirTags       = "tags"
	DirContent    = "content"
	DirServices   = "services"
	DirVersions   = "versions"
	DirSpecs      = "specs"

	// DirData is the per-artifact namespace for hydration JSON. Everything
	// under DirData contains rendered spec content for the document and is
	// classified protected for private artifacts.
	DirData  = "data"
	DirPages = "pages"
	DirViz   = "viz"

	FileIndexHTML               = "index.html"
	FileGuidesHTML              = "guides.html"
	FileDiagnosticsHTML         = "diagnostics.html"
	FileIndexJSON               = "index.json"
	FileBundleJSON              = "bundle.json"
	FileManifestJSON            = "manifest.json"
	FileNavJSON                 = "nav.json"
	FileLLMIndex                = "llms.txt"
	FileLLMFull                 = "llms-full.txt"
	FileLLMOperations           = "llms-operations.txt"
	FileLLMModels               = "llms-models.txt"
	FileAgentsGuide             = "AGENTS.md"
	FileStateSQLite             = ".printingpress-state.db"
	FileCatalogContentStateJSON = ".printingpress-catalog-content.json"

	FilePB33FThemeCSS             = "pb33f-theme.css"
	FileCowboyComponentsCSS       = "cowboy-components.css"
	FileShoelaceDarkCSS           = "shoelace-dark.css"
	FilePrintingPressCSS          = "printing-press.css"
	FileChromaCSS                 = "chroma.css"
	FilePrintingPressIndexCSS     = "printing-press-index.css"
	FilePrintingPressCatalogCSS   = "printing-press-catalog.css"
	FilePrintingPressOperationCSS = "printing-press-operation.css"
	FilePrintingPressModelCSS     = "printing-press-model.css"
	FilePrintingPressJS           = "printing-press.js"
	FilePrintingPressLiteJS       = "printing-press-lite.js"

	// NavCacheBaseName is the basename (no extension) of the per-artifact
	// navigation/registry hydration asset; writeHydrationAsset appends .json
	// or .js based on the asset mode.
	NavCacheBaseName = "nav"

	DiagnosticsSlug = "diagnostics"
	OrphansJSONPath = "diagnostics-orphans.json"
)

Variables

This section is empty.

Functions

func AggregateServiceDir

func AggregateServiceDir(serviceSlug string) string

func AggregateServiceIndexHTML

func AggregateServiceIndexHTML(serviceSlug string) string

func AggregateServiceIndexJSON

func AggregateServiceIndexJSON(serviceSlug string) string

func AggregateServiceLLM

func AggregateServiceLLM(serviceSlug string) string

func AggregateServiceVersionsDir

func AggregateServiceVersionsDir(serviceSlug string) string

func AggregateServiceVersionsIndexHTML

func AggregateServiceVersionsIndexHTML(serviceSlug string) string

func AggregateServiceVersionsIndexJSON

func AggregateServiceVersionsIndexJSON(serviceSlug string) string

func AggregateSpecAgentsGuide added in v0.0.56

func AggregateSpecAgentsGuide(serviceSlug, versionSlug, entrySlug string) string

func AggregateSpecDir

func AggregateSpecDir(serviceSlug, versionSlug, entrySlug string) string

func AggregateSpecIndexHTML

func AggregateSpecIndexHTML(serviceSlug, versionSlug, entrySlug string) string

func AggregateSpecLLM added in v0.0.56

func AggregateSpecLLM(serviceSlug, versionSlug, entrySlug string) string

func AggregateVersionDir

func AggregateVersionDir(serviceSlug, versionSlug string) string

func AggregateVersionIndexHTML

func AggregateVersionIndexHTML(serviceSlug, versionSlug string) string

func AggregateVersionIndexJSON

func AggregateVersionIndexJSON(serviceSlug, versionSlug string) string

func AggregateVersionLLM

func AggregateVersionLLM(serviceSlug, versionSlug string) string

func ContentAsset added in v0.0.73

func ContentAsset(pageSlug, assetName string) string

func ContentPageDataBase added in v0.0.73

func ContentPageDataBase(slugPath string) string

func ContentPageHTML added in v0.0.73

func ContentPageHTML(slugPath string) string

func DiagnosticsHTMLPath added in v0.0.61

func DiagnosticsHTMLPath() string

func DiagnosticsPageDataBase added in v0.0.61

func DiagnosticsPageDataBase() string

func GuidesIndexHTML added in v0.0.73

func GuidesIndexHTML() string

func ModelDiagramVizBase

func ModelDiagramVizBase(typeSlug, slug string) string

func ModelGraphVizBase

func ModelGraphVizBase(typeSlug, slug string) string

func ModelHTML

func ModelHTML(typeSlug, slug string) string

func ModelJSON

func ModelJSON(typeSlug, slug string) string

func ModelMarkdown

func ModelMarkdown(typeSlug, slug string) string

func ModelPageDataBase

func ModelPageDataBase(typeSlug, slug string) string

func ModelTypeIndexHTML

func ModelTypeIndexHTML(typeSlug string) string

func ModelsIndexHTML

func ModelsIndexHTML() string
func NavCacheBase() string

NavCacheBase is the per-artifact path (no extension) for the navigation and schema-registry hydration asset. writeHydrationAsset appends .json or .js.

func OperationHTML

func OperationHTML(slug string) string

func OperationJSON

func OperationJSON(slug string) string

func OperationMarkdown

func OperationMarkdown(slug string) string

func OperationPageDataBase

func OperationPageDataBase(slug string) string

func PageDataDir added in v0.0.64

func PageDataDir() string

PageDataDir is the per-artifact directory for page hydration JSON.

func PageVizDir added in v0.0.64

func PageVizDir() string

PageVizDir is the per-artifact directory for visualization hydration JSON.

func RootPageDataBase added in v0.0.61

func RootPageDataBase() string

func StaticAsset

func StaticAsset(name string) string

StaticAsset returns the path of a shared asset relative to the renderer's embedded static tree (e.g. "static/printing-press.js"). Hosts that mount the embedded FS at a public URL strip DirStatic when serving.

func StaticDirs

func StaticDirs() []string

func StaticFontsDir

func StaticFontsDir() string

func StaticShoelaceIconsDir

func StaticShoelaceIconsDir() string

func TagHTML

func TagHTML(slug string) string

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL