Skip to content

docs(readme): rewrite the "library" example to match the real surface #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bigin merged 1 commit into from
May 16, 2026
Merged

docs(readme): rewrite the "library" example to match the real surface #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,25 @@ docs/ themes.md, install-shared-hosting.md, …
<?php

use Scriptor\Boot\App;
use Scriptor\Boot\ImanagerBootstrap;
use Imanager\Storage\ItemRepository;
use Scriptor\Boot\Frontend\Site;

require __DIR__ . '/vendor/autoload.php';
// Loads the autoloader, builds the iManager container on App::container(),
// and populates $config from data/settings/scriptor-config.php.
require __DIR__ . '/boot.php';

App::set(ImanagerBootstrap::create(__DIR__)); // __DIR__ = the Scriptor root
$site = new Site(App::container(), $config, __DIR__);

$item = App::container()->get(ItemRepository::class)->find(1);
// Data access — read pages directly off the Pages category:
$home = $site->pages()->findHome(); // or ->findBySlug('contact')
echo $home->name; // page title
echo $home->content; // markdown source

// Theme rendering — resolves $_SERVER['REQUEST_URI'] to a Page and
// returns the same fragments the bundled themes' template.php consumes.
// Call from your own front controller:
$site->execute();
echo $site->render('content'); // page body, rendered + cached
echo $site->render('navigation'); // theme nav
```

See `boot/Frontend/Site.php` for the full set of services the bundled
Expand Down