Skip to content

parseDocsPath

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/apps/api/src/git-sync/git-sync.types.ts

Parse docs/<scope>/<lang>/<slug>.md into its identity parts. Null for anything that doesn't match the exact 3-segment shape with a KNOWN audience scope — the substrate never serves any other layout, so an unparseable path can never become a createPath.

Signature

ts
function parseDocsPath(substratePath: string): DocsPathParts | null

Parameters

NameType
substratePathstring

Returns: DocsPathParts | null

Was this page helpful?

Download as PDF