ghost 5.66.1 → 5.67.0

package/content/themes/source/gulpfile.js

@@ -0,0 +1,174 @@
+const {series, watch, src, dest, parallel} = require('gulp');
+const pump = require('pump');
+const path = require('path');
+const releaseUtils = require('@tryghost/release-utils');
+const inquirer = require('inquirer');
+
+// gulp plugins and utils
+const livereload = require('gulp-livereload');
+const postcss = require('gulp-postcss');
+const zip = require('gulp-zip');
+const concat = require('gulp-concat');
+const uglify = require('gulp-uglify');
+const beeper = require('beeper');
+const fs = require('fs');
+
+// postcss plugins
+const autoprefixer = require('autoprefixer');
+const cssnano = require('cssnano');
+const easyimport = require('postcss-easy-import');
+
+const REPO = 'TryGhost/Source';
+const REPO_READONLY = 'TryGhost/Source';
+const CHANGELOG_PATH = path.join(process.cwd(), '.', 'changelog.md');
+
+function serve(done) {
+    livereload.listen();
+    done();
+}
+
+const handleError = (done) => {
+    return function (err) {
+        if (err) {
+            beeper();
+        }
+        return done(err);
+    };
+};
+
+function hbs(done) {
+    pump([
+        src(['*.hbs', 'partials/**/*.hbs']),
+        livereload()
+    ], handleError(done));
+}
+
+function css(done) {
+    pump([
+        src('assets/css/screen.css', {sourcemaps: true}),
+        postcss([
+            easyimport,
+            autoprefixer(),
+            cssnano()
+        ]),
+        dest('assets/built/', {sourcemaps: '.'}),
+        livereload()
+    ], handleError(done));
+}
+
+function js(done) {
+    pump([
+        src([
+            // pull in lib files first so our own code can depend on it
+            'assets/js/lib/*.js',
+            'assets/js/*.js'
+        ], {sourcemaps: true}),
+        concat('source.js'),
+        uglify(),
+        dest('assets/built/', {sourcemaps: '.'}),
+        livereload()
+    ], handleError(done));
+}
+
+function zipper(done) {
+    const filename = require('./package.json').name + '.zip';
+
+    pump([
+        src([
+            '**',
+            '!node_modules', '!node_modules/**',
+            '!dist', '!dist/**',
+            '!yarn-error.log',
+            '!yarn.lock',
+            '!gulpfile.js'
+        ]),
+        zip(filename),
+        dest('dist/')
+    ], handleError(done));
+}
+
+const cssWatcher = () => watch('assets/css/**', css);
+const jsWatcher = () => watch('assets/js/**', js);
+const hbsWatcher = () => watch(['*.hbs', 'partials/**/*.hbs'], hbs);
+const watcher = parallel(cssWatcher, jsWatcher, hbsWatcher);
+const build = series(css, js);
+
+exports.build = build;
+exports.zip = series(build, zipper);
+exports.default = series(build, serve, watcher);
+
+exports.release = async () => {
+    // @NOTE: https://yarnpkg.com/lang/en/docs/cli/version/
+    // require(./package.json) can run into caching issues, this re-reads from file everytime on release
+    let packageJSON = JSON.parse(fs.readFileSync('./package.json'));
+    const newVersion = packageJSON.version;
+
+    if (!newVersion || newVersion === '') {
+        console.log(`Invalid version: ${newVersion}`);
+        return;
+    }
+
+    console.log(`\nCreating release for ${newVersion}...`);
+
+    const githubToken = process.env.GST_TOKEN;
+
+    if (!githubToken) {
+        console.log('Please configure your environment with a GitHub token located in GST_TOKEN');
+        return;
+    }
+
+    try {
+        const result = await inquirer.prompt([{
+            type: 'input',
+            name: 'compatibleWithGhost',
+            message: 'Which version of Ghost is it compatible with?',
+            default: '5.0.0'
+        }]);
+
+        const compatibleWithGhost = result.compatibleWithGhost;
+
+        const releasesResponse = await releaseUtils.releases.get({
+            userAgent: 'Source',
+            uri: `https://api.github.com/repos/${REPO_READONLY}/releases`
+        });
+
+        if (!releasesResponse || !releasesResponse) {
+            console.log('No releases found. Skipping...');
+            return;
+        }
+
+        let previousVersion = releasesResponse[0].tag_name || releasesResponse[0].name;
+        console.log(`Previous version: ${previousVersion}`);
+
+        const changelog = new releaseUtils.Changelog({
+            changelogPath: CHANGELOG_PATH,
+            folder: path.join(process.cwd(), '.')
+        });
+
+        changelog
+            .write({
+                githubRepoPath: `https://github.com/${REPO}`,
+                lastVersion: previousVersion
+            })
+            .sort()
+            .clean();
+
+        const newReleaseResponse = await releaseUtils.releases.create({
+            draft: true,
+            preRelease: false,
+            tagName: 'v' + newVersion,
+            releaseName: newVersion,
+            userAgent: 'Source',
+            uri: `https://api.github.com/repos/${REPO}/releases`,
+            github: {
+                token: githubToken
+            },
+            content: [`**Compatible with Ghost ≥ ${compatibleWithGhost}**\n\n`],
+            changelogPath: CHANGELOG_PATH
+        });
+        console.log(`\nRelease draft generated: ${newReleaseResponse.releaseUrl}\n`);
+    } catch (err) {
+        console.error(err);
+        process.exit(1);
+    }
+};

package/content/themes/source/home.hbs

@@ -0,0 +1,12 @@
+{{!< default}}
+{{!-- The tag above means: insert everything in this file into the body of the default.hbs template --}}
+
+{{> "components/header" headerStyle=@custom.header_style}}
+
+{{#match @custom.header_style "!=" "Highlight"}}
+    {{> "components/featured" showFeatured=@custom.show_featured_posts limit=4}}
+{{/match}}
+
+{{> "components/cta"}}
+
+{{> "components/post-list" feed="home" postFeedStyle=@custom.post_feed_style showTitle=true showSidebar=@custom.show_publication_info_sidebar}}

package/content/themes/source/index.hbs

@@ -0,0 +1,6 @@
+{{!< default}}
+{{!-- The tag above means: insert everything in this file into the body of the default.hbs template --}}
+
+<main class="gh-main">
+    {{> "components/post-list" feed="index" postFeedStyle=@custom.post_feed_style showTitle=true showSidebar=@custom.show_publication_info_sidebar}}
+</main>

package/content/themes/source/package.json

@@ -0,0 +1,202 @@
+{
+    "name": "source",
+    "description": "A default theme for the Ghost publishing platform",
+    "demo": "https://source.ghost.io",
+    "version": "1.0.0",
+    "engines": {
+        "ghost": ">=5.0.0"
+    },
+    "license": "MIT",
+    "scripts": {
+        "dev": "gulp",
+        "zip": "gulp zip",
+        "test": "gscan .",
+        "test:ci": "gscan --fatal --verbose .",
+        "pretest": "gulp build",
+        "preship": "yarn test",
+        "ship": "STATUS=$(git status --porcelain); echo $STATUS; if [ -z \"$STATUS\" ]; then yarn version && git push --follow-tags; else echo \"Uncomitted changes found.\" && exit 1; fi",
+        "postship": "git fetch && gulp release"
+    },
+    "author": {
+        "name": "Ghost Foundation",
+        "email": "hello@ghost.org",
+        "url": "https://ghost.org/"
+    },
+    "gpm": {
+        "type": "theme",
+        "categories": [
+            "Minimal",
+            "Magazine"
+        ]
+    },
+    "keywords": [
+        "ghost",
+        "theme",
+        "ghost-theme"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/TryGhost/Source.git"
+    },
+    "bugs": "https://github.com/TryGhost/Source/issues",
+    "contributors": "https://github.com/TryGhost/Source/graphs/contributors",
+    "devDependencies": {
+        "@tryghost/release-utils": "0.8.1",
+        "autoprefixer": "10.4.7",
+        "beeper": "2.1.0",
+        "cssnano": "5.1.12",
+        "gscan": "4.39.4",
+        "gulp": "4.0.2",
+        "gulp-concat": "2.6.1",
+        "gulp-livereload": "4.0.2",
+        "gulp-postcss": "9.0.1",
+        "gulp-uglify": "3.0.2",
+        "gulp-zip": "5.1.0",
+        "inquirer": "8.2.4",
+        "postcss": "8.2.13",
+        "postcss-easy-import": "4.0.0",
+        "pump": "3.0.0"
+    },
+    "browserslist": [
+        "defaults"
+    ],
+    "config": {
+        "posts_per_page": 16,
+        "image_sizes": {
+            "xs": {
+                "width": 160
+            },
+            "s": {
+                "width": 320
+            },
+            "m": {
+                "width": 600
+            },
+            "l": {
+                "width": 960
+            },
+            "xl": {
+                "width": 1200
+            },
+            "xxl": {
+                "width": 2000
+            }
+        },
+        "card_assets": true,
+        "custom": {
+            "navigation_layout": {
+                "type": "select",
+                "options": [
+                    "Logo in the middle",
+                    "Logo on the left",
+                    "Stacked"
+                ],
+                "default": "Logo in the middle"
+            },
+            "site_background_color": {
+                "type": "color",
+                "default": "#ffffff"
+            },
+            "header_and_footer_color": {
+                "type": "select",
+                "options": [
+                    "Background color",
+                    "Accent color"
+                ],
+                "default": "Background color"
+            },
+            "title_font": {
+                "type": "select",
+                "options": [
+                    "Modern sans-serif",
+                    "Elegant serif",
+                    "Consistent mono"
+                ],
+                "default": "Modern sans-serif"
+            },
+            "body_font": {
+                "type": "select",
+                "options": [
+                    "Modern sans-serif",
+                    "Elegant serif"
+                ],
+                "default": "Modern sans-serif"
+            },
+            "signup_heading": {
+                "type": "text",
+                "description": "Used in your footer across your theme, defaults to site title when empty"
+            },
+            "signup_subheading": {
+                "type": "text",
+                "description": "Defaults to site description when empty"
+            },
+            "header_style": {
+                "type": "select",
+                "options": [
+                    "Landing",
+                    "Highlight",
+                    "Magazine",
+                    "Search",
+                    "Off"
+                ],
+                "description": "Landing is recommended for all sites, Highlight & Magazine for those with more content",
+                "default": "Landing",
+                "group": "homepage"
+            },
+            "header_text": {
+                "type": "text",
+                "group": "homepage",
+                "description": "Defaults to site description when empty",
+                "visibility": "header_style:[Landing, Search]"
+            },
+            "background_image": {
+                "type": "boolean",
+                "default": true,
+                "description": "Use the publication cover set on the Brand tab as your background",
+                "group": "homepage",
+                "visibility": "header_style:[Landing, Search]"
+            },
+            "show_featured_posts": {
+                "type": "boolean",
+                "default": false,
+                "group": "homepage",
+                "visibility": "header_style:[Highlight, Magazine]"
+            },
+            "post_feed_style": {
+                "type": "select",
+                "options": [
+                    "List",
+                    "Grid"
+                ],
+                "default": "List",
+                "group": "homepage"
+            },
+            "show_images_in_feed": {
+                "type": "boolean",
+                "default": true,
+                "group": "homepage",
+                "visibility": "post_feed_style:List"
+            },
+            "show_author": {
+                "type": "boolean",
+                "default": true,
+                "group": "homepage"
+            },
+            "show_publish_date": {
+                "type": "boolean",
+                "default": true,
+                "group": "homepage"
+            },
+            "show_publication_info_sidebar": {
+                "type": "boolean",
+                "default": false,
+                "group": "homepage"
+            }
+        }
+    },
+    "renovate": {
+        "extends": [
+            "@tryghost:theme"
+        ]
+    }
+}

package/content/themes/source/page.hbs

@@ -0,0 +1,26 @@
+{{!< default}}
+{{!-- The tag above means: insert everything in this file into the body of the default.hbs template --}}
+
+{{#post}}
+
+<main class="gh-main">
+    <article class="gh-article {{post_class}}">
+
+        {{#match @page.show_title_and_feature_image}}
+            <header class="gh-article-header gh-canvas">
+                <h1 class="gh-article-title is-title">{{title}}</h1>
+                {{#if custom_excerpt}}
+                    <p class="gh-article-excerpt is-body">{{custom_excerpt}}</p>
+                {{/if}}
+                {{> "feature-image"}}
+            </header>
+        {{/match}}
+
+        <section class="gh-content gh-canvas is-body">
+            {{content}}
+        </section>
+
+    </article>
+</main>
+
+{{/post}}

package/content/themes/source/partials/components/cta.hbs

@@ -0,0 +1,25 @@
+{{#if @site.members_enabled}}
+    {{#unless @member}}
+        {{#match @custom.header_style "!=" "Landing"}}
+        {{#match @custom.header_style "!=" "Search"}}
+        {{#match @custom.header_style "!=" "Off"}}
+        {{#match posts.length ">=" 7}}
+            <section class="gh-cta gh-outer">
+                <div class="gh-cta-inner gh-inner">
+                    <div class="gh-cta-content">
+                        <h2 class="gh-cta-title is-title">
+                            {{#if @custom.signup_heading}}{{@custom.signup_heading}}{{else}}{{@site.title}}{{/if}}
+                        </h2>
+                        <p class="gh-cta-description is-body">
+                            {{#if @custom.signup_subheading}}{{@custom.signup_subheading}}{{else}}{{@site.description}}{{/if}}
+                        </p>
+                    </div>
+                    {{> "email-subscription"}}
+                </div>
+            </section>
+        {{/match}}
+        {{/match}}
+        {{/match}}
+        {{/match}}
+    {{/unless}}
+{{/if}}

package/content/themes/source/partials/components/featured.hbs

@@ -0,0 +1,14 @@
+{{#if showFeatured}}
+    {{#get "posts" filter="featured:true" include="authors" limit=limit as |featured|}}
+        <section class="gh-featured gh-outer">
+            <div class="gh-featured-inner gh-inner">
+                <h2 class="gh-featured-title">Featured</h2>
+                <div class="gh-featured-feed">
+                    {{#foreach featured}}
+                        {{> "post-card" imageSizes="80px"}}
+                    {{/foreach}}
+                </div>
+            </div>
+        </section>
+    {{/get}}
+{{/if}}

package/content/themes/source/partials/components/footer.hbs

@@ -0,0 +1,35 @@
+<footer class="gh-footer{{#match @custom.header_and_footer_color "Accent color"}} has-accent-color{{/match}} gh-outer">
+    <div class="gh-footer-inner gh-inner">
+
+        <div class="gh-footer-bar">
+            <span class="gh-footer-logo is-title">
+                {{#if @site.logo}}
+                    <img src="{{@site.logo}}" alt="{{@site.title}}">
+                {{else}}
+                    {{@site.title}}
+                {{/if}}
+            </span>
+            <nav class="gh-footer-menu">
+                {{navigation type="secondary"}}
+            </nav>
+            <div class="gh-footer-copyright">
+                Powered by <a href="https://ghost.org/" target="_blank" rel="noopener">Ghost</a>
+            </div>
+        </div>
+        
+        {{#if @site.members_enabled}}
+            {{#unless @member}}
+                <section class="gh-footer-signup">
+                    <h2 class="gh-footer-signup-header is-title">
+                        {{#if @custom.signup_heading}}{{@custom.signup_heading}}{{else}}{{@site.title}}{{/if}}
+                    </h2>
+                    <p class="gh-footer-signup-subhead is-body">
+                        {{#if @custom.signup_subheading}}{{@custom.signup_subheading}}{{else}}{{@site.description}}{{/if}}
+                    </p>
+                    {{> "email-subscription"}}
+                </section>
+            {{/unless}}
+        {{/if}}
+
+    </div>
+</footer>

package/content/themes/source/partials/components/header-content.hbs

@@ -0,0 +1,81 @@
+<section class="gh-header is-{{#match headerStyle "Magazine"}}magazine{{else match headerStyle "Highlight"}}highlight{{else}}classic{{/match}}{{#if @custom.background_image}}{{#if @site.cover_image}} has-image{{/if}}{{/if}} gh-outer">
+        
+    {{!-- Background image --}}
+    {{#if @custom.background_image}}
+        {{#match headerStyle "!=" "Magazine"}}
+        {{#match headerStyle "!=" "Highlight"}}
+            {{#if @site.cover_image}}
+                <img class="gh-header-image" src="{{@site.cover_image}}" alt="{{@site.title}}">
+            {{/if}}
+        {{/match}}
+        {{/match}}
+    {{/if}}
+
+    <div class="gh-header-inner gh-inner">
+
+        {{!-- Highlight layout --}}
+        {{#match headerStyle "Highlight"}}
+            <div class="gh-header-left">
+                {{#foreach posts limit="1"}}
+                    {{> "post-card" imageSizes="(max-width: 767px) calc(100vw - max(8vmin, 40px)), 640px"}}
+                {{/foreach}}
+            </div>
+            <div class="gh-header-middle">
+                {{#foreach posts from="2" limit="3"}}
+                    {{> "post-card"}}
+                {{/foreach}}
+            </div>
+            <div class="gh-header-right">
+                {{#if @custom.show_featured_posts}}
+                    {{> "components/featured" showFeatured=@custom.show_featured_posts limit=6}}
+                {{else}}
+                    <div class="gh-featured-feed">
+                        {{#foreach posts from="5" limit="6"}}
+                            {{> "post-card" imageSizes="80px"}}
+                        {{/foreach}}
+                    </div>
+                {{/if}}
+            </div>
+        {{/match}}
+
+        {{!-- Magazine layout --}}
+        {{#match headerStyle "Magazine"}}
+            {{#foreach posts limit="7"}}
+                {{#match @number 2}}
+                    <div class="gh-header-left">
+                {{/match}}
+                {{#match @number 5}}
+                    <div class="gh-header-right">
+                {{/match}}
+                {{#if @first}}
+                    {{> "post-card" imageSizes="640px"}}
+                {{else}}
+                    {{> "post-card"}}
+                {{/if}}
+                {{#match @number 4}}
+                    </div>
+                {{/match}}
+                {{#match @number 7}}
+                    </div>
+                {{/match}}
+            {{/foreach}}
+        {{/match}}
+
+        {{!-- Landing layout --}}
+        {{#match headerStyle "Landing"}}
+            <h1 class="gh-header-title is-title">{{#if @custom.header_text}}{{@custom.header_text}}{{else}}{{@site.description}}{{/if}}</h1>
+            {{> "email-subscription"}}
+        {{/match}}
+
+        {{!-- Search layout --}}
+        {{#match headerStyle "Search"}}
+            <h1 class="gh-header-title is-title">{{#if @custom.header_text}}{{@custom.header_text}}{{else}}{{@site.description}}{{/if}}</h1>
+            <form class="gh-form">
+                {{> "icons/search"}}
+                <button class="gh-form-input" data-ghost-search>Search posts, tags and authors</button>
+            </form>
+        {{/match}}
+
+    </div>
+
+</section>

package/content/themes/source/partials/components/header.hbs

@@ -0,0 +1,19 @@
+{{#match headerStyle "!=" "Off"}}
+
+    {{#match headerStyle "Highlight"}}
+        {{> "components/header-content"}}
+    {{else match headerStyle "Magazine"}}
+        {{> "components/header-content"}}
+    {{else}}
+        {{#match headerStyle "Landing"}}
+            {{#if @site.members_enabled}}
+                {{#unless @member}}
+                    {{> "components/header-content"}}
+                {{/unless}}
+            {{/if}}
+        {{else}}
+            {{> "components/header-content"}}
+        {{/match}}
+    {{/match}}
+
+{{/match}}

package/content/themes/source/partials/components/navigation.hbs

@@ -0,0 +1,53 @@
+<header id="gh-navigation" class="gh-navigation is-{{#match navigationLayout "Logo on the left"}}left-logo{{else match navigationLayout "Stacked"}}stacked{{else}}middle-logo{{/match}}{{#match @custom.header_and_footer_color "Accent color"}} has-accent-color{{/match}} gh-outer">
+    <div class="gh-navigation-inner gh-inner">
+
+        <div class="gh-navigation-brand">
+            <a class="gh-navigation-logo is-title" href="{{@site.url}}">
+                {{#if @site.logo}}
+                    <img src="{{@site.logo}}" alt="{{@site.title}}">
+                {{else}}
+                    {{@site.title}}
+                {{/if}}
+            </a>
+            {{> "search-toggle"}}
+            <button class="gh-burger gh-icon-button">
+                {{> "icons/burger"}}
+                {{> "icons/close"}}
+            </button>
+        </div>
+
+        <nav class="gh-navigation-menu">
+            {{navigation}}
+            {{#unless @site.members_enabled}}
+                {{#match navigationLayout "Stacked"}}
+                    {{> "search-toggle"}}
+                {{/match}}
+            {{/unless}}
+        </nav>
+
+        <div class="gh-navigation-actions">
+            {{#unless @site.members_enabled}}
+                {{^match navigationLayout "Stacked"}}
+                    {{> "search-toggle"}}
+                {{/match}}
+            {{else}}
+                {{> "search-toggle"}}
+                <div class="gh-navigation-members">
+                    {{#unless @member}}
+                        {{#unless @site.members_invite_only}}
+                            <a href="#/portal/signin" data-portal="signin">Sign in</a>
+                            {{#unless hideSubscribeButton}}
+                                <a class="gh-button" href="#/portal/signup" data-portal="signup">Subscribe</a>
+                            {{/unless}}
+                        {{else}}
+                            <a class="gh-button" href="#/portal/signin" data-portal="signin">Sign in</a>
+                        {{/unless}}
+                    {{else}}
+                        <a class="gh-button" href="#/portal/account" data-portal="account">Account</a>
+                    {{/unless}}
+                </div>
+            {{/unless}}
+        </div>
+
+    </div>
+</header>