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
35
README.md
35
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# FolderWeb
|
||||
|
||||
**Just enough, nothing more.** Drop Markdown files in folders, and they become pages. No database, no build process.
|
||||
**Just enough, nothing more.** Drop content files in folders, and they become pages. No database, no build process.
|
||||
|
||||
## What is FolderWeb?
|
||||
|
||||
|
|
@ -11,38 +11,41 @@ FolderWeb is a content publishing framework where your file system is your conte
|
|||
## Key Features
|
||||
|
||||
- **File-based routing**: `content/blog/post/` → `yoursite.com/blog/post/`
|
||||
- **Multi-language support**: Built-in i18n with URL prefixes
|
||||
- **Template system**: Override defaults with custom templates
|
||||
- **Multiple content formats**: Write in Markdown, HTML, or PHP — and mix them freely within the same page. Use Markdown for prose, HTML for structured sections, and PHP when you need dynamic output. Prefix filenames with numbers (`10-intro.md`, `20-gallery.html`) to control render order.
|
||||
- **Template system**: Override any default template with your own
|
||||
- **Multi-language support**: Built-in i18n with URL prefixes and per-file translations
|
||||
- **Modern CSS**: CSS variables, nesting, OKLCH colors, grid layouts
|
||||
- **No build process**: Save and refresh—see changes immediately
|
||||
- **No build process**: Save and refresh — see changes immediately
|
||||
|
||||
## Example Structure
|
||||
|
||||
```
|
||||
project/
|
||||
├── app/ # App (never modify)
|
||||
├── app/ # Application (never modify)
|
||||
├── content/ # Your website content
|
||||
│ ├── front.md # Home page
|
||||
│ ├── about/ # About page
|
||||
│ ├── about/
|
||||
│ │ └── about-me.md
|
||||
│ └── blog/ # Blog with list view
|
||||
│ ├── metadata.ini # Configure template
|
||||
│ ├── portfolio/
|
||||
│ │ ├── 10-intro.md # Markdown prose
|
||||
│ │ ├── 20-gallery.html # HTML layout
|
||||
│ │ └── 30-stats.php # Dynamic PHP output
|
||||
│ └── blog/
|
||||
│ ├── metadata.ini
|
||||
│ ├── 2025-11-01-first-post/
|
||||
│ │ ├── first-post.md
|
||||
│ │ ├── cover.jpg
|
||||
│ │ └── metadata.ini
|
||||
│ └── 2025-11-02-second-post/
|
||||
│ └── another-post.md
|
||||
│ └── post.md
|
||||
└── custom/ # Your customizations
|
||||
├── templates/ # Custom templates
|
||||
├── styles/ # Custom CSS
|
||||
└── config.ini # Configuration
|
||||
├── templates/
|
||||
├── styles/
|
||||
└── config.ini
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
**Complete documentation available in [`docs/`](docs/)**
|
||||
Complete documentation available in [`docs/`](docs/).
|
||||
|
||||
## Learn More
|
||||
|
||||
Start with the **[Getting Started Tutorial](docs/tutorial/00-getting-started.md)** or browse the **[complete documentation](docs/)**.
|
||||
Start with the **[Getting Started guide](docs/01-getting-started/index.md)** or browse the **[tutorial](docs/02-tutorial/)**.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue