# markdown-source.ts **[Source](https://github.com/ubugeeei-prod/ox-content/blob/main/npm/vite-plugin-ox-content/src/markdown-source.ts)** > 15 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

15 symbols 11 functions 3 interfaces 1 modules 28 parameters 11 members 11 returns

## Reference

fn

buildMarkdownSourceIndex(input: { files: readonly string[]; srcDir: string; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; publishState?: ResolvedPublishStateOptions; }): Promise<Map<string, MarkdownSourceIndexEntry>>

Builds a companion index from source files without transforming Markdown.6 paramsreturns Promise<Map<string, MarkdownSourceIndexEntry>>

Builds a companion index from source files without transforming Markdown.

Signature

export async function buildMarkdownSourceIndex(input: {
  files: readonly string[];
  srcDir: string;
  permalinks?: ResolvedPermalinksOptions | null;
  cascade?: ResolvedCascadeOptions | null;
  publishState?: ResolvedPublishStateOptions;
}): Promise<Map<string, MarkdownSourceIndexEntry>>

Parameters

input { files: readonly string[]; srcDir: string; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; publishState?: ResolvedPublishStateOptions }
input.files readonly string[]
input.srcDir string
input.permalinks? ResolvedPermalinksOptions | null

optional
input.cascade? ResolvedCascadeOptions | null

optional
input.publishState? ResolvedPublishStateOptions

optional

Returns

Promise<Map<string, MarkdownSourceIndexEntry>>

fninjectMarkdownSourceAlternate(html: string, href: string): stringInserts <link rel="alternate" type="text/markdown"> before </head>.2 paramsreturns string

Inserts <link rel="alternate" type="text/markdown"> before </head>.

Signature

export function injectMarkdownSourceAlternate(html: string, href: string): string

Parameters

html string
href string

Returns

string

fnisMarkdownSourceRequest(pathname: string): booleanTrue when the request pathname is a .md companion URL.1 paramreturns boolean

True when the request pathname is a .md companion URL.

Signature

export function isMarkdownSourceRequest(pathname: string): boolean

Parameters

pathname string

Returns

boolean

modulemarkdown-sourceOpt-in Markdown source companions written beside generated HTML. Copies already-read source bytes. Does not re-parse Ma…

Opt-in Markdown source companions written beside generated HTML.

Copies already-read source bytes. Does not re-parse Markdown to emit them.

fnmarkdownSourceHref(urlPath: string, base: string): string | undefinedPublic companion href, including base. Always ends in .md.2 paramsreturns string | undefined

Public companion href, including base. Always ends in .md.

Signature

export function markdownSourceHref(urlPath: string, base: string): string | undefined

Parameters

urlPath string
base string

Returns

string | undefined

fn

markdownSourceHrefForPage(input: { source: string; fileUrl: string; frontmatter: Record<string, unknown>; base: string; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; publishState?: ResolvedPublishStateOptions; }): string | undefined

Companion href for one page after permalink / publish-state checks.8 paramsreturns string | undefined

Companion href for one page after permalink / publish-state checks.

Signature

export function markdownSourceHrefForPage(input: {
  source: string;
  fileUrl: string;
  frontmatter: Record<string, unknown>;
  base: string;
  permalinks?: ResolvedPermalinksOptions | null;
  cascade?: ResolvedCascadeOptions | null;
  publishState?: ResolvedPublishStateOptions;
}): string | undefined

Parameters

input { source: string; fileUrl: string; frontmatter: Record<string, unknown>; base: string; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; publishState?: ResolvedPublishStateOptions }
input.source string
input.fileUrl string
input.frontmatter Record<string, unknown>
input.base string
input.permalinks? ResolvedPermalinksOptions | null

optional
input.cascade? ResolvedCascadeOptions | null

optional
input.publishState? ResolvedPublishStateOptions

optional

Returns

string | undefined

interfaceMarkdownSourceIndexEntryOne entry in the dev-server companion index.2 members

One entry in the dev-server companion index.

Signature

export interface MarkdownSourceIndexEntry

Members

Properties

Name	Type	Description
`allowed`	`boolean`
`source`	`string`

fnmarkdownSourceOutputPath(outDir: string, urlPath: string): string | undefinedFilesystem path for a companion, or undefined when it would escape outDir.2 paramsreturns string | undefined

Filesystem path for a companion, or undefined when it would escape outDir.

Signature

export function markdownSourceOutputPath(outDir: string, urlPath: string): string | undefined

Parameters

outDir string
urlPath string

Returns

string | undefined

interfaceMarkdownSourcePageInputOne page that may receive a source companion.4 members

One page that may receive a source companion.

Signature

export interface MarkdownSourcePageInput

Members

Properties

Name	Type	Description
`frontmatter`	`Record<string, unknown>`
`inputPath`	`string`
`source`optional	`string`	Already-read source bytes. Omitted pages are skipped.
`urlPath`	`string`

fnparseSourceFrontmatter(source: string): Record<string, unknown>Frontmatter keys only — not a Markdown parse.1 paramreturns Record<string, unknown>

Frontmatter keys only — not a Markdown parse.

Signature

export function parseSourceFrontmatter(source: string): Record<string, unknown>

Parameters

source string

Returns

Record<string, unknown>

fnresolveMarkdownSourceOptions(value: boolean | MarkdownSourceOptions | undefined): ResolvedMarkdownSourceOptionsResolves ssg.markdownSource with defaults. false / omitted stays off. true enab…1 paramreturns ResolvedMarkdownSourceOptions

Resolves ssg.markdownSource with defaults.

false / omitted stays off. true enables companions and the alternate link. An object enables the feature and overrides only the fields set.

Signature

export function resolveMarkdownSourceOptions(value: boolean | MarkdownSourceOptions | undefined): ResolvedMarkdownSourceOptions

Parameters

value boolean | MarkdownSourceOptions | undefined

Returns

ResolvedMarkdownSourceOptions

fn

resolveMarkdownSourceRequest(pathname: string, index: ReadonlyMap<string, MarkdownSourceIndexEntry>): MarkdownSourceIndexEntry | undefined

Looks up a companion after the site base has been stripped.2 paramsreturns MarkdownSourceIndexEntry | undefined

Looks up a companion after the site base has been stripped.

Signature

export function resolveMarkdownSourceRequest(pathname: string, index: ReadonlyMap<string, MarkdownSourceIndexEntry>): MarkdownSourceIndexEntry | undefined

Parameters

pathname string
index ReadonlyMap<string, MarkdownSourceIndexEntry>

Returns

MarkdownSourceIndexEntry | undefined

fnshouldPublishMarkdownSource(frontmatter: Record<string, unknown>, publishState?: ResolvedPublishStateOptions): booleanWhether this page may publish a companion. Draft and unlisted source is never e…2 paramsreturns boolean

Whether this page may publish a companion.

Draft and unlisted source is never emitted. When publishState is on, scheduled / expired pages follow that filter and includeDrafts is ignored so preview HTML cannot leak source.

Signature

export function shouldPublishMarkdownSource(frontmatter: Record<string, unknown>, publishState?: ResolvedPublishStateOptions): boolean

Parameters

frontmatter Record<string, unknown>
publishState ResolvedPublishStateOptions

optional

Returns

boolean

fnwriteMarkdownSourceFiles(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>Writes enabled companions from already-read source bytes.1 paramreturns Promise<{ files: string[]; errors: string[] }>

Writes enabled companions from already-read source bytes.

Signature

export async function writeMarkdownSourceFiles(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>

Parameters

input WriteMarkdownSourceFilesInput

Returns

Promise<{ files: string[]; errors: string[] }>

interfaceWriteMarkdownSourceFilesInputInputs for writing companions next to generated HTML.5 members

Inputs for writing companions next to generated HTML.

Signature

export interface WriteMarkdownSourceFilesInput

Members

Properties

Name	Type	Description
`base`	`string`
`options`optional	`ResolvedMarkdownSourceOptions \| null`
`outDir`	`string`
`pages`	`readonly MarkdownSourcePageInput[]`
`publishState`optional	`ResolvedPublishStateOptions`