From 3b8ef3169e54a5621cad23322d2ca220ccfe6022 Mon Sep 17 00:00:00 2001 From: Sami Samhuri Date: Sat, 7 Feb 2026 19:35:52 -0800 Subject: [PATCH] Restore README customization section --- Readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Readme.md b/Readme.md index 3216e89..a248d46 100644 --- a/Readme.md +++ b/Readme.md @@ -48,6 +48,16 @@ Site metadata and project data are configured with TOML files at the repository `Pressa.create_site` loads both files from the provided `source_path` and still supports URL overrides for `debug`, `beta`, and `release` builds. +## Customizing for your site + +If this workflow seems like a good fit, here is the minimum to make it your own: + +- Update `site.toml` with your site identity (`author`, `email`, `title`, `description`, `url`) and any global `scripts` / `styles`. +- Define your projects in `projects.toml` using `[[projects]]` entries with `name`, `title`, `description`, and `url`. +- Configure project-page-only assets in `site.toml` under `[projects_plugin]` (`scripts` and `styles`). +- Keep the built-in plugins (`Posts::Plugin` and `Projects::Plugin`) or add your own by implementing `Pressa::Plugin` in `lib/` and registering it in `lib/config/loader.rb`. +- Adjust rendering and layout in `lib/views/` and the static content in `public/` as needed. + Other targets: ```bash