Skip to content
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.

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

[5.x] version of Storyteller #4

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 1 addition & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
.DS_Store
.env
node_modules/
bower_components/
local
statamic
installer.php
phpunit.xml
please
index.php

66 changes: 48 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,60 @@
## Storyteller Theme ![Statamic 2.0](https://img.shields.io/badge/statamic-2.8-blue.svg?style=flat-square)
<!-- statamic:hide --><p align="center"><img src="https://statamic.com/assets/branding/Statamic-Logo-Rad.png" width="100" alt="Statamic Logo" /></p>
<h1 align="center">
Statamic Starter Kit: Storyteller
</h1>

This site theme is designed to highlight the new [Bard Fieldtype](https://docs.statamic.com/fieldtypes/bard) and it's magnificent capabilities. It includes a number of pre-built Bard sets for long form content.
![Statamic 4+](https://img.shields.io/badge/Statamic-4+-FF269E?style=for-the-badge&link=https://statamic.com)
<!-- /statamic:hide -->

- Hero Blocks with background images and color/mix overlays
- Photos
- Video Embeds
- Two Column Text
## Features
- Bard's focused starter-kit with a number of pre-built Bard sets for long form content:
- Hero Blocks with background images and color/mix overlays
- Photos that can be customized for the front-end in 5 different sizes
- Video Embeds
- Two Column Text
- Image gallery

## Screenshot:
- Articles blogging collection with all articles heroes on the home page
- Tags taxonomy for Articles
- Beautifully responsive
- Built with [TailwindCSS](https://tailwindcss.com)

![Storyteller Preview](https://d.pr/i/VqnfH/aXEnVnAj5C+)
## Quick Start

Or you can see it in action at [new.jackmcdade.com](https://jackmcdade.com/blog).
### 1. Create a new site

## Installing
You can create a new site using the [Statamic CLI Tool](https://github.com/statamic/cli):

- Setup a fresh Statamic install
- Unzip the Storyteller package
- Replace the contents of `site` and `assets` with those from the package
- Create a super user to access the Control Panel
```
statamic new your-site statamic/starter-kit-storyteller
```

Or you can install manually into a fresh [Statamic installation](https://statamic.dev/installation) by running:

```
php please starter-kit:install statamic/starter-kit-storyteller --clear-site
```

### 2. Make a new user

## Customizing
The above installers should prompt you to make a user, but you can also run `php please make:user`. You'll want it to be a `super` so you have access to everything.

Storyteller is essentially drop-and-go for new sites. You can modify some design elements in the Globals area to make it your own. And if you want to really go at it, you can mess around in the templates. Everything uses [Tailwind](https://tailwindcss.com) so it's very easy to make changes.
### 3. Recompile the CSS (optional)

The [TailwindCSS](https://tailwindcss.com/) included in this kit is compiled and purged to reduce filesize on any unused classes and selectors. If you want to modify anything, just recompile it.

Change your markup in the antlers.html files and/or in style.css and compile for production again:

```
cd site/themes/storyteller
yarn && yarn run dev
npm run build
```

This starter-kit makes use of Vite 4.5 for blazing fast assets compilation.

### 4. Do your thing!

If you're using [Laravel Valet](https://laravel.com/docs/valet) (or similar), your site should be available at `http://cool-site.test`. You can access the control panel at `http://cool-site.test/cp` and login with your new user. Open up the source code, follow along with the [Statamic docs](https://statamic.dev), and enjoy!

## Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the [code of conduct](https://github.com/statamic/cms/wiki/Code-of-Conduct).
9 changes: 9 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "my-vendor-name/path",
"extra": {
"statamic": {
"name": "Path",
"description": "Path starter kit"
}
}
}
File renamed without changes.
8 changes: 8 additions & 0 deletions content/assets/assets.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: Assets
disk: assets
allow_uploads: true
allow_downloading: true
allow_renaming: true
allow_moving: true
create_folders: true
source_preset: max_upload_size
8 changes: 8 additions & 0 deletions content/assets/site-assets.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: Site-Assets
disk: site-assets
allow_uploads: true
allow_downloading: true
allow_renaming: true
allow_moving: true
create_folders: true
warm_presets: false
File renamed without changes.
18 changes: 18 additions & 0 deletions content/collections/articles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
title: Articles
template: articles/show
layout: layout
mount: home
taxonomies:
- tags
revisions: true
route: '/articles/{slug}'
date: true
sort_dir: asc
date_behavior:
past: public
future: private
preview_targets:
-
label: Entry
url: '{permalink}'
refresh: true
226 changes: 226 additions & 0 deletions content/collections/articles/2024-03-24.oh-hai-sacha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
---
id: 1d241e40-02ed-4c88-8650-58bc5e7beb31
blueprint: article
title: 'Oh Hai Sacha!'
subtitle: "You'll never believe what starter-kit Statamic just re-added!"
background_image: noah-grossenbacher-272202.jpg
grayscale: none
background_color: '#fd2d78'
blend_mode: multiply
section_title: Stories
updated_by: b6c04226-2d48-4c4f-80a8-b14f535a693c
updated_at: 1712325969
tags:
- bard
- good-bull
- writing
content:
-
type: heading
attrs:
level: 2
content:
-
type: text
text: 'A sub heading which is not as important as the second, but should be used with consideration'
-
type: paragraph
content:
-
type: text
text: 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. When you have an itch to scratch that you can’t reach natively (talking about features here), you’ve always able to extend '
-
type: text
marks:
-
type: link
attrs:
href: '#'
rel: noreferrer
target: _blank
title: null
text: Statamic
-
type: text
text: ' by creating an addon.'
-
type: paragraph
content:
-
type: text
text: 'However, creating a whole addon, with all of it’s naming requirements and whatnot just to write (for example) 3 lines of PHP can be annoying and time consuming. With site helpers, you can just drop your code into a single file and call it a day.'
-
type: set
attrs:
id: lu5t4whz
values:
type: two_col
col_one: |-
### Jack
But I must explain to you how all this mistaken idea of denouncing of a pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it?
> But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences?<br><br>_Nikolaj Sokolowski_
col_two: |-
### Jason
On the other hand, we denounce with righteous indignation and dislike men who are so beguiled and demoralized by the charms of pleasure of the moment, so blinded by desire, that they cannot foresee the pain and trouble that are bound to ensue; and equal blame belongs to those who fail in their duty through weakness of will, which is the same as saying through shrinking from toil and pain. These cases are perfectly simple and easy to distinguish. In a free hour, when our power of choice is untrammeled and when nothing prevents our being able to do what we like best, every pleasure is to be welcomed and every pain avoided. But in certain circumstances and owing to the claims of duty or the obligations of business it will frequently occur that pleasures have to be repudiated and annoyances accepted. The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.

Wie im Morgenrot
Du rings mich anglühst,
Frühling, Geliebter !
Mit tausendfacher Liebeswonne
Sich an mein Herz drängt
Deiner ewigen Wärme
Heilig Gefühl,
Unendliche Schöne !
-
type: paragraph
content:
-
type: text
text: 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.'
-
type: paragraph
content:
-
type: text
text: 'When you have an itch to scratch that you can’t reach natively (talking about features here), you’ve always able to extend Statamic by creating an addon.'
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'Image can be Inline:'
-
type: set
attrs:
id: lubp4qvi
values:
type: photo
image: thiva-xX_Bptw-MhE-unsplash.jpg
grayscale: none
size: 'md lg:max-w-md xl:max-w-md'
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'Inline+ image gets slightly larger at large screen size:'
-
type: set
attrs:
id: lu5tb4qy
values:
type: photo
image: chuttersnap-297553.jpg
grayscale: none
size: 'md lg:max-w-md xl:max-w-lg'
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'Let’s try an Oversized image:'
-
type: set
attrs:
id: lubp9s85
values:
type: photo
image: patrick-federi-OfxkOGuSO_k-unsplash.jpg
grayscale: none
size: 'lg lg:max-w-xl xl:max-w-xl'
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'Or what about Oversized+?'
-
type: set
attrs:
id: lu5tbgjb
values:
type: photo
image: jason-pischke-G58Nyod4KCs-unsplash.jpg
grayscale: grayscale
size: 'lg lg:max-w-xl xl:max-w-2xl'
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'Finally, isn’t Full Size the real deal?'
-
type: set
attrs:
id: lu5tdk44
values:
type: photo
image: 20230430_203852.jpg
grayscale: none
size: full
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'It’s H3 time, again!'
-
type: paragraph
content:
-
type: text
text: 'Later that day I climbed this cliff face for a shot of the sunset and got stuck up there overnight. The medicine man appeared again, smelling even funnier than before. He told me I was destined for grape things. I was confused. And then he disappeared. Grape things?'
-
type: blockquote
content:
-
type: paragraph
content:
-
type: text
text: 'You are destined for grape things.'
-
type: paragraph
content:
-
type: text
text: "I woke to a hot air balloon over my head. They swooped down and asked if I wanted a lift. When presented with adventure, you just say yes. That's my motto. And up I went. I don’t remember anything else."
-
type: set
attrs:
id: lu5tis4z
values:
type: video
video: 'https://youtu.be/6_Fd8R9Bat8?feature=shared'
-
type: heading
attrs:
level: 3
content:
-
type: text
text: 'I did tell you with have a new gallery feature, didnt’t I?'
-
type: set
attrs:
id: luchzbc9
values:
type: gallery
gallery:
- thiva-xX_Bptw-MhE-unsplash.jpg
- patrick-federi-OfxkOGuSO_k-unsplash.jpg
- jason-pischke-G58Nyod4KCs-unsplash.jpg
- andrew-haimerl-381931.jpg
---
13 changes: 13 additions & 0 deletions content/collections/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Pages
template: default
layout: layout
revisions: false
route: '{slug}'
sort_dir: asc
preview_targets:
-
label: Entry
url: '{permalink}'
refresh: true
structure:
root: true
8 changes: 8 additions & 0 deletions content/collections/pages/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: home
blueprint: pages
title: Stories
template: articles/index
updated_by: b6c04226-2d48-4c4f-80a8-b14f535a693c
updated_at: 1711188539
---
File renamed without changes.
6 changes: 6 additions & 0 deletions content/globals/settings.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
title: Settings
data:
site_name: Storyteller
website_short_description: 'My short stories I would like to tell you about'
website_allow_pinterest: true
site_background_image: efe-kurnaz-315384.jpg
File renamed without changes.
File renamed without changes.
Loading