How meta.json Works and Its Structure

[codezeros]

Hello

I'm currently working on a documentation project using FumaDocs, and I need assistance structuring the meta.json files. but I don't know how meta.json works where it needs to be placed and it's structure and options i want to organize the documentation effectively and reduce the number of MDX files. by organizing all the files and sub-folders according to how I want and it needs to display a sidebar with a title for each group of pages

[muhammad-fiaz]

Hello @codezeros

this is sample contents/docs/meta.json

{
  /**
   * The title of the documentation or project.
   * This is displayed prominently at the top of the documentation page.
   */
  "title": "Getting Started",

  /**
   * A brief description of the documentation or project.
   * This provides an overview or summary and is often displayed below the title.
   */
  "description": "A Brief Introduction on how to get started!",

  /**
   * An icon representing the documentation or project.
   * This can be a string referencing an icon name for a custom icon component of your application
   */
  "icon": "Building2",

  /**
   * Indicates whether this is the root metadata file for the entire documentation.
   * The root file should contain an overview and links to other sections.
   * Set to true for the main meta.json file at the top level.
   */
  "root": true,

  /**
   * An array of pages or sections included in this documentation.
   * Each entry can be a string referring to a markdown (MDX) file or a section title.
   * Special entries like "---Introduction---" can be used to group related pages.
   * The "..." entry can be used to include all MDX files in the directory.
   */
  "pages": [
    "---Introduction---",    // A group title for introductory content
    "index",                 // The main page for the documentation
    "other",                 // Additional pages (can be listed by their filenames without .mdx extension) and you can also include folder names
    "---Projects---",        // A group title for project-specific documentation
    "..."                    // Includes all remaining MDX files in the directory
  ]
} 

this is how meta.json works and it needs to be placed in contents/docs/ folder in whichever folder u need custom sidebar items and it also includes a subfolder then for handling mdx refer to #1280 and for more about meta.json refer https://fumadocs.vercel.app/docs/ui/page-conventions#meta

I hope this helps :)

[codezeros]

Thanks!! This is what I wanted!