From 6468a3b7a8ecda9017e0b0e80a324ba85c203c25 Mon Sep 17 00:00:00 2001 From: Dan Kleine Date: Fri, 18 Oct 2024 14:24:39 +0200 Subject: [PATCH] feat: Link to main repository Remove all redundant information and add a working link to the main repository. --- README.md | 82 +++++-------------------------------------------------- 1 file changed, 7 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 7588b1d..daaf700 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,14 @@ -# Stitcher [![Build Status](https://scrutinizer-ci.com/g/pageon/stitcher-core/badges/build.png?b=develop)](https://scrutinizer-ci.com/g/pageon/stitcher-core/build-status/develop) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pageon/stitcher-core/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/pageon/stitcher-core/?branch=develop) [![Code Coverage](https://scrutinizer-ci.com/g/pageon/stitcher-core/badges/coverage.png?b=develop)](https://scrutinizer-ci.com/g/pageon/stitcher-core/?branch=develop) +# Stitcher Core +[![Build Status](https://scrutinizer-ci.com/g/pageon/stitcher-core/badges/build.png?b=develop)](https://scrutinizer-ci.com/g/pageon/stitcher-core/build-status/develop) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pageon/stitcher-core/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/pageon/stitcher-core/?branch=develop) [![Code Coverage](https://scrutinizer-ci.com/g/pageon/stitcher-core/badges/coverage.png?b=develop)](https://scrutinizer-ci.com/g/pageon/stitcher-core/?branch=develop) -High performance, static websites for PHP developers. +**High performance, static websites for PHP developers.** + +This repository contains the core library for the [Stitcher project](https://github.com/pageon/stitcher). +To set up a skeleton project run the following composer command: ```sh composer create-project pageon/stitcher ``` -### Why Stitcher? - -Stitcher differs from many other static site generator in two areas. First of all: **performance is key**. Stitcher is built from its core for high performance websites. All tools available to you put performance on the first place. Secondly, it doesn't try to add extra syntax to existing formats. Stitcher provides a robust set of tools **for developers** to build with, and not a lot of hacks so everything fits in one file. - -Also important to note, included with Stitcher: - -- Automatic image optimization, as easy as `image.srcset` -- HTTP/2 server push support -- Markdown, YAML and JSON -- Twig and Smarty support -- Data set overviews and details; pagination, sorting and filtering -- Built-in SASS support -- JavaScript and CSS minification -- Built-in SEO and meta tag optimizations - -A quick look at Stitcher: - -```yaml -# site.yml - -/blog: - template: blog - variables: - posts: data/blog.yml - -/blog/{id}: - template: blog.post - variables: - post: data/blog.yml - adapters: - collection: - variable: post - field: id -``` - -```yaml -# data/blog.yml - -hello_world: - date: 2017-03-10 - highlight: false - title: Hello world - content: blog/hello.md - image: hello_world.jpg - -foo_bar: - date: 2017-03-14 - highlight: true - title: Foo Bar - content: blog/far_bar.md - image: foo_bar.jpg -``` - -```html - - -{% extends 'index.html' %} - -{% block content %} -
-

{{ blog.title }}

- - {{ blog.image.alt }} - - {{ blog.content }} -
-{% endblock %} -``` - -You can read more about it on [the Stitcher website](https://www.stitcher.io). - +↗️ Read more about content creation and templates at [github.com/pageon/stitcher](https://github.com/pageon/stitcher).