Doc() — ui Function Reference

Architecture documentation for the Doc() function in contentlayer.config.js from the ui codebase.

Function javascript ComponentRegistry Styles

Entity Profile

ComponentRegistry→ Styles→ Doc() — ui Function Reference

Dependency Diagram

graph TD
  318213d8_73b0_7492_ef37_f8429554e4d0["Doc()"]
  3ab0029b_bc98_e23e_7c0d_e96099aed850["contentlayer.config.js"]
  318213d8_73b0_7492_ef37_f8429554e4d0 -->|defined in| 3ab0029b_bc98_e23e_7c0d_e96099aed850
  style 318213d8_73b0_7492_ef37_f8429554e4d0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

deprecated/www/contentlayer.config.js lines 41–79

export const Doc = defineDocumentType(() => ({
  name: "Doc",
  filePathPattern: `docs/**/*.mdx`,
  contentType: "mdx",
  fields: {
    title: {
      type: "string",
      required: true,
    },
    description: {
      type: "string",
      required: true,
    },
    published: {
      type: "boolean",
      default: true,
    },
    links: {
      type: "nested",
      of: LinksProperties,
    },
    featured: {
      type: "boolean",
      default: false,
      required: false,
    },
    component: {
      type: "boolean",
      default: false,
      required: false,
    },
    toc: {
      type: "boolean",
      default: true,
      required: false,
    },
  },
  computedFields,
}))