Update documentation for mixed content formats and ordering
Clarify that content files can be Markdown, HTML, or PHP Add explanation of numbered prefixes for file ordering Update example structures to reflect new capabilities Standardize documentation links and formatting
This commit is contained in:
parent
9be457f17f
commit
e7e360005d
2 changed files with 32 additions and 27 deletions
|
|
@ -97,19 +97,21 @@ content/
|
|||
|
||||
## Multiple Files in One Page
|
||||
|
||||
You can combine multiple content files in a single directory. They render in **alphabetical order**:
|
||||
You can combine multiple content files in a single directory. They render as a single page, combined in filename order.
|
||||
|
||||
**Prefix filenames with numbers to control the order:**
|
||||
|
||||
```
|
||||
content/portfolio/
|
||||
├── 00-hero.php # Renders first
|
||||
├── 01-intro.md # Renders second
|
||||
├── 02-gallery.html # Renders third
|
||||
└── 03-contact.md # Renders last
|
||||
├── 10-hero.php # Renders first — dynamic PHP banner
|
||||
├── 20-intro.md # Renders second — Markdown prose
|
||||
├── 30-gallery.html # Renders third — HTML layout
|
||||
└── 40-contact.md # Renders last — Markdown form
|
||||
```
|
||||
|
||||
All four files render as one page at `/portfolio/`.
|
||||
All four files render as one page at `/portfolio/`. You can mix `.md`, `.html`, and `.php` freely — use whichever format fits each section best.
|
||||
|
||||
**Use case:** Build pages from modular components—header, content, footer, etc.
|
||||
**Why number prefixes?** Files are sorted using natural sort (`strnatcmp`), so `10-` comes before `20-` comes before `30-`. Using increments of 10 leaves room to insert new sections later without renaming existing files. Files without a number prefix sort after numbered files.
|
||||
|
||||
## Dates in Folder Names
|
||||
|
||||
|
|
@ -273,13 +275,13 @@ summary = "An introduction to my blog"
|
|||
|
||||
```
|
||||
content/services/
|
||||
├── 00-hero.php
|
||||
├── 01-intro.md
|
||||
├── 02-pricing.html
|
||||
├── 10-hero.php
|
||||
├── 20-intro.md
|
||||
├── 30-pricing.html
|
||||
└── metadata.ini
|
||||
```
|
||||
|
||||
All files render together as one page at `/services/`.
|
||||
All content files render together as one page at `/services/`, in number-prefix order.
|
||||
|
||||
### Documentation Site
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue