Home
Project Structure
Learn how an Illuminate project is structured.
These are the critical files and folders within your project:
src/├─ docs/│ ├─ index.mdx├─ images/│ ├─ icon.png│ ├─ image.png│ ├─ logo.svg├─ illuminate.config.js
docs
The docs folder is where all .mdx files are stored. Files in this folder
will be automatically rendered as pages. Subfolders should be organized to
reflect how will be grouped in the navigation menu. The directory structure will
also determine the relative path for the page. Refer to
Markdown and MDX to learn how to create pages for
your documentation.
images
The images folder is where any image files that are used site-wide are stored,
such as logos, favicons, and Open Graph (OG) protocol images. Images used in
pages should be stored alongside the corresponding page in the docs folder.
Refer to Configuration for more information
about what each image is used for and how to customize them.
illuminate.config.js
The illuminate.config.js file is where all the global settings for the website
are stored, such as the navigation menu items, site metadata information, and
social media links. Refer to Configuration to learn how
to customize the configuration for your documentation.