Help

Open source & contributing

Timber is open source, made by indies for indies. The whole point is that you can read it, change it and host it yourself.

Get the code#

Download the zip, or clone the repository (the app is the timber_v1 folder), and run it locally:

cd timber_v1
php -S localhost:8430 router.php

There's no build step and no dependencies to install, so you can start editing immediately.

License#

Timber is released as open source. The exact license text is in the LICENSE file in your download. If you're redistributing or using it for client work, check that file for the terms.

Ways to help#

Try it and tell us what confused you. First-run friction is the most valuable feedback.
Report bugs with your PHP version, web server, what you did and what you expected.
Write a theme and share it — a zip of themes/yourtheme + assets/themes/yourtheme is all it takes.
Improve the docs. They live as Markdown in the website repository (_build/docs-src/); rebuild with php _build/build.php docs.
Pick something off the roadmap — tests, an image pipeline, search and an updater are all well-scoped.
Add a migration source (Ghost, Squarespace, Jekyll…) using the same pipeline the WordPress migrator uses.

Principles for changes#

No build step. If a change needs a compiler, it probably doesn't belong.
No required third-party service.
Settings over code for anything an owner might change.
Readable beats clever. The next person should understand it in one pass.
Keep the install a single upload and a one-minute setup.

Working on the docs#

# edit a page
_build/docs-src/installation.md
# rebuild the static docs (the website copy and the copy inside the download)
php _build/build.php docs

The docs are static HTML, so they work anywhere — in your Timber, on GitHub Pages, on any host, or straight from disk.

Security reports#

Please report vulnerabilities privately to the maintainers rather than in a public issue, and allow time for a fix. See Security model.