PageLinks

tcmts.cli.pages.PageLinks · #jcv6g53k · type

export interface PageLinks {
  /** where a definition's text document is (`tcm:/lib/square.ts`) */
  viewUri(hash: string): string;
  /** whether the doc's examples are evaluated (default: they are). A page served to anyone runs no code: not */
  evaluate?: boolean;
  /** the doc's metadata tags (`@since`, `@category`, …) apart from its markdown, in `docMeta`, for a page that shows them its own way */
  metaApart?: boolean;
}

used by