xyd 0.1.0-beta - Coming Soon

Reference
/
Page Meta

Page Meta

Properties

    title
    string
    Required
    The main title of the content - by default visible in navigation and page title
    sidebarTitle
    string
    Title to display in the sidebar navigation
    description
    string
    Display description for SEO/llms.txt purposes
    icon
    string
    Icon identifier for the navigation item
    layout
    PageLayout "wide" | "page" | "reader"
    Layout type for the content display
    maxTocDepth
    number
    Max depth for table of contents
    url
    string
    External URL for the content
    copyPage
    boolean
    If false, hide the copy page button
    uniform
    PageMetaUniform
    Uniform for API Docs references
      PageMetaUniformDetails
      PageMetaUniformDetails
      Uniform details allows to specify more options than just the path, for example eager loading
        path
        string
        Required
        Path to the uniform file / url
        eager
        boolean
        If true, the uniform will be eagerly loaded
      string
      string
    hidden
    boolean
    If true, hide from navigation
    tocCard
    Optional 'tocCard' for custom cards in the table of contents
      TocCard
      TocCard
        link
        string
        Required
        'link' to the card
        title
        string
        Required
        'title' of the card
        description
        string
        Required
        'description' of the card
        icon
        string
        'icon' of the card
      TocCard[]
      TocCard[]
Built with

Show your support! Star us on GitHub ⭐️