ruben/folderweb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
69 commits 1 branch 0 tags 621 KiB
PHP 73.8%
Shell 19.1%
CSS 5.2%
Dockerfile 1%
HTML 0.9%
Find a file
Ruben e7e360005d 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
2026-02-07 18:59:41 +01:00
app Add metadata and config changes to cache invalidation 2026-02-07 16:12:21 +01:00
devel Add performance profiling tools and test data generator 2026-01-14 14:40:57 +01:00
docs Update documentation for mixed content formats and ordering 2026-02-07 18:59:41 +01:00
.gitignore Add docs directory to gitignore 2025-11-02 13:46:05 +01:00
AGENT.md Update AGENT.md and add architecture documentation 2026-02-05 23:30:44 +01:00
README.md Update documentation for mixed content formats and ordering 2026-02-07 18:59:41 +01:00

README.md

FolderWeb

Just enough, nothing more. Drop content files in folders, and they become pages. No database, no build process.

What is FolderWeb?

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.

Core principle: Simplicity and longevity over features and complexity.

Key Features

  • 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/.

Start with the Getting Started guide or browse the tutorial.