Getting Started
Prezet Content Directory
Prezet reads markdown files, images, and metadata from the prezet
filesystem disk configured in config/filesystems.php
. By default, the prezet
disk uses the local
driver with its root set to the prezet
directory in your application's base path, but you can configure it to use any supported Laravel storage driver.
#Directory Structure
When you install a Prezet template, some example content will be added to the prezet
directory to get you familiar with the expected structure. An example of that content might look like this:
prezet/
├── content/
│ ├── installation.md
│ ├── configuration.md
│ └── features/
│ └── frontmatter.md
├── images/
│ ├── example-20240509210223449.webp
│ └── ogimages/
│ └── ...
└── SUMMARY.md
#content/
Contains your markdown files organized in subdirectories. Each markdown file includes front matter and content that's converted to HTML when rendered.
You can organize content in any directory structure. File paths determine the default URL slugs. For example, content/features/frontmatter.md
would be accessible at /features/frontmatter
.
#images/
Stores images referenced in your markdown files. When you reference an image, Prezet automatically serves it through the Image Controller for optimization.
The ogimages/
subdirectory contains Open Graph images. Learn more about OG Image Generation.
#SUMMARY.md
Defines the navigation structure. Controls the order and organization of content in your template's navigation (sidebar, menu, etc.).
Format:
## Section Title
- [](content/page-namePage Title](content/page-name](content/page-name)
- [](content/folder/page-nameAnother Page](content/folder/page-name](content/folder/page-name)
See the SUMMARY.md documentation for more details.
#Changing the Folder Location
The content folder location is configured in config/filesystems.php
:
'disks' => [
'prezet' => [
'driver' => 'local',
'root' => base_path('prezet'),
],
],