Update README, more screenshots.
This commit is contained in:
@@ -1,8 +1,10 @@
|
||||
|
||||
|
||||
# Pagerite
|
||||
|
||||
A CMS for people who are done patching WordPress. There's no PHP or Node.js to exploit — the whole editing surface sits behind your own SSO proxy, so the server the internet can talk to just renders plain pages that search engines and social media can read too. Further, the articles have rich layout and don't look boxed in like with most web publishing platforms. The software is lightweight and fast enough to serve any number of visitors you have.
|
||||
A CMS for people who are done patching WordPress. There's no PHP or Node.js to exploit — the whole editing surface sits behind your own SSO proxy, so the server the internet can talk to just renders plain pages that search engines and social media can read too.
|
||||
|
||||
We run our own site [vasanko.com](https://vasanko.com/) on it, in case you wish to have a quick look.
|
||||
The articles have rich layout and don't look boxed in like with most web publishing platforms. The software is lightweight and fast enough to serve any number of visitors you have. We run our own site [vasanko.com](https://vasanko.com/) on it, in case you wish to have a quick look.
|
||||
|
||||
## Run it
|
||||
|
||||
@@ -10,36 +12,23 @@ We run our own site [vasanko.com](https://vasanko.com/) on it, in case you wish
|
||||
uvx pagerite localhost
|
||||
```
|
||||
|
||||
That serves a demo site on localhost using [uv](https://docs.astral.sh/uv/getting-started/installation/). When you take it to production, pass your domain name instead. Our [setup guide](https://git.zi.fi/LeoVasanko/pagerite/src/branch/main/docs/setup.md) walks through the whole production arrangement.
|
||||
That serves a demo site on localhost using [uv](https://docs.astral.sh/uv/getting-started/installation/). When you take it to production, pass your domain name instead. Our [setup guide](https://git.zi.fi/LeoVasanko/pagerite/src/branch/main/docs/setup.md) walks through the whole production arrangement. **Read it before running this online.**
|
||||
|
||||
## What it's like
|
||||
|
||||
**You write, it renders.** Articles are Markdown with the extensions that matter — tables, footnotes, task lists, callouts, highlighted code, aside boxes — and raw HTML goes through untouched when Markdown runs out. Layout is yours to command from the text: float an image `{.right}`, drop a note in the `{.margin}`, let a photo or a code block go `{.wide}` across the whole viewport. Long articles reflow into a proper two-column composition on wide screens without you doing anything.
|
||||
**You write, Pagerite renders.** Articles are Markdown with the extensions that matter — tables, footnotes, task lists, callouts, highlighted code, aside boxes — and raw HTML goes through untouched when Markdown runs out. Long articles reflow into a proper two-column composition on wide screens without you doing anything.
|
||||
|
||||
<!-- screenshot: a rich article layout — margin notes, wide figure, code -->
|
||||
|
||||
**Editing happens on the page.** Click the pen next to a heading and an editor docks beside the live article, previewing server-side as you type. Site name, theme, fonts, banner, custom CSS — changed in a panel, applied immediately. New pages grow from a ➕ in the structure tree; drag or rename rows to reorder your whole navigational hierarchy. Entirely custom or premade top banner designs per category or page are available.
|
||||
**Editing happens on the page.** Click the pen next to a heading and an editor docks beside the live article, previewing server-side as you type. Site name, theme, fonts, banner, custom CSS — changed in a panel, applied immediately. New pages grow from a ➕ in the structure tree; drag or rename rows to reorder your whole navigational hierarchy. Entirely custom or premade top banner designs per category or page are available, animations included.
|
||||
|
||||
Full scripting and styling is available for editors who wish to implement more complex functionality on their articles. This also means you should only let trusted users write on your site: this is by no means a public blog platform.
|
||||
|
||||
The worst case scenario when a hacker gains access to your admin accounts: they can take over the entire site and run scripts on user's browsers, but the damage is limited to same domain. All your articles can be restored to the state prior to that hack or that one user's edits undone, and no data is irrecoverably lost. This is much better than other platforms that also let hackers run code on your server (WordPress).
|
||||
The worst case scenario when a hacker gains access to your admin accounts (say if you didn't read the setup guide): they can take over the entire site and run scripts on users' browsers, but the damage is limited to same domain. All your articles can be restored to the state prior to that hack or that one user's edits undone, and no data is irrecoverably lost. This is much better than other platforms that also let hackers run code on your server (WordPress).
|
||||
|
||||
<!-- screenshot: the editor docked on a live page -->
|
||||
|
||||
|
||||
**Theming is one CSS file.** Themes, banner designs and page transitions are plain CSS (plus a bit of SVG) read straight from disk — pick one from the site editor or copy a folder and make it yours. Fonts are self-hosted; your site never phones a third party for anything.
|
||||
**Theme just every part to your liking.** Themes, banner designs and page transitions are included — pick one from the site editor or copy a folder and make it yours. Several high quality fonts are included among with other assets: your site never phones a third party or us for anything. And if after all you need to customize, additional site and banner code may be provided by the admin panel.
|
||||
|
||||
<!-- screenshot: the same site in several themes, as a collage -->
|
||||
**Search engines and social cards come free.** Every page gets a proper description, canonical link and Open Graph/Twitter card metadata derived from the article — including a share image picked from your own figures — without a single "SEO plugin". Category index pages, if you wish to have those, also get their sub pages shown automatically in card format.
|
||||
|
||||
**Search engines and social cards come free.** Every page gets a proper description, canonical link and Open Graph/Twitter card metadata derived from the article — including a share image picked from your own figures — without a single "SEO plugin".
|
||||
|
||||
**You can see your readers.** Built-in analytics need no cookies and no third-party tracker: visits, referers, reading time and a live map of how people move between your pages, plus separate ledgers for crawlers and the scanners probing for `/.env` — who are, of course, wasting their time here.
|
||||
|
||||
<!-- screenshot: the analytics view -->
|
||||
|
||||
## Keeping the doors locked
|
||||
|
||||
Pagerite has no accounts of its own. Pair it with [Paskia](https://git.zi.fi/leovasanko/paskia), a small SSO server that gates the editing API behind your reverse proxy — the : systemd service, Caddy (or your proxy of choice), and forward-auth. On your own machine, with no proxy, editing is simply open.
|
||||
|
||||
## More
|
||||
|
||||
The details — architecture, content model, theming, analytics — live in the [documentation](docs/overview.md).
|
||||
|
||||
_You can see your readers. Built-in analytics need no cookies and no third-party tracker: visits, referers, reading time and a live map of how people move between your pages, plus separate ledgers for crawlers and the abusers probing for wordpress PHP files — who are, of course, wasting their time here._
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
Reference in New Issue
Block a user