folderweb/README.md

52 lines
2.2 KiB
Markdown
Raw Normal View History

# FolderWeb
2025-10-02 16:54:47 +02:00
**Just enough, nothing more.** Drop content files in folders, and they become pages. No database, no build process.
2025-10-02 16:54:47 +02:00
## What is FolderWeb?
2025-10-02 16:54:47 +02:00
FolderWeb is a content publishing framework where your file system is your content management system. Create a folder structure that mirrors your site hierarchy, drop files into folders, and they immediately become pages.
2025-10-02 16:54:47 +02:00
**Core principle**: Simplicity and longevity over features and complexity.
2025-10-02 16:54:47 +02:00
## Key Features
2025-10-02 16:54:47 +02:00
- **File-based routing**: `content/blog/post/``yoursite.com/blog/post/`
- **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
## Example Structure
```
project/
├── app/ # Application (never modify)
├── content/ # Your website content
│ ├── front.md # Home page
│ ├── about/
│ │ └── about-me.md
│ ├── 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/
│ └── post.md
└── custom/ # Your customizations
├── templates/
├── styles/
└── config.ini
```
## Documentation
Complete documentation available in [`docs/`](docs/).
Start with the **[Getting Started guide](docs/01-getting-started/index.md)** or browse the **[tutorial](docs/02-tutorial/)**.