folderweb/README.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

# FolderWeb
2025-10-02 16:54:47 +02:00
**Just enough, nothing more.** Drop Markdown 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/`
- **Multi-language support**: Built-in i18n with URL prefixes
- **Template system**: Override defaults with custom templates
- **Modern CSS**: CSS variables, nesting, OKLCH colors, grid layouts
- **No build process**: Save and refresh—see changes immediately
## Example Structure
```
project/
├── app/ # App (never modify)
├── content/ # Your website content
│ ├── front.md # Home page
│ ├── about/ # About page
│ │ └── about-me.md
│ └── blog/ # Blog with list view
│ ├── metadata.ini # Configure template
│ ├── 2025-11-01-first-post/
│ │ ├── first-post.md
│ │ ├── cover.jpg
│ │ └── metadata.ini
│ └── 2025-11-02-second-post/
│ └── another-post.md
└── custom/ # Your customizations
├── templates/ # Custom templates
├── styles/ # Custom CSS
└── config.ini # Configuration
```
## Documentation
**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/)**.