growdigital / groundwork Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 0.0 677 KB

Metalsmith blog template. It rocks. Not maintained 😞

Home Page: https://www.groundwork.rocks/

License: Other

HTML 37.74% JavaScript 27.44% CSS 34.82%

metalsmith airbnb javascript eslint semantic-release prettier-eslint bem modular-css blog-template blog

groundwork's Introduction

Groundwork

Development has halted 😞 Please @gohugoio & Indiego 🙂

Metalsmith blog template. It rocks.

Static site blog template built with Metalsmith, featuring Modular CSS, for web designers that code. Promoting IndieWeb principles of Publish (on your) Own Site, Syndicate Elsewhere.

Installation

Install with $ git clone… not $ npm install…. Make sure you have Git and Node.js.

$ git clone [email protected]:growdigital/groundwork
$ cd groundwork
$ npm install
$ npm run dev

Features

Simple installation via git clone
Modular CSS and JS: each component/object is a separate file
Auto-publish to Twitter, Facebook and Google+
Blog and status post types set up

Documentation

Make it your own: enter your details in package.json and index.js
Change your CSS settings /src/assets/css/settings/
Modify/create templates in /layouts/ and /partials/
Add new modules in /src/components/ (discrete components) and /src/objects/ (design patterns).
Get rid of legacy CSS in /src/assets/css/shame.css
Create new posts in /src/posts/
Push to your git repo eg on GitHub
Publish to the platform of your choice eg Netlify, Now, Surge…

In-depth documentation: www.groundwork.rocks

Issues and features in the Groundwork Roadmap 😍

Contact

Jake Rayson [email protected] @growdigital
Twitter @GroundworkRocks

Made with pride in Wales

groundwork's People

Contributors

Stargazers

Watchers

groundwork's Issues

Create metalsmsith-groundwork-cli

Create simple installation tool for metalsmith-groundwork blog template, so user can $ groundwork-cli setup

Possible options:

site
  name
  description
  url 
package
  package name
  author (default your username)
  license (default MIT)
  private (default true)
  repo type (default git)
  repo url

Put microformat into if statement in body

Use front matter image fields to put figure, image, caption into body, if image is present.

Mark up with microformats

Use branch name:

img-microformat

Fix piping RSS feed to Twitter, Facebook, Google+

Currently, RSS feed not piping marked up posts.

Set up dlvrit account (3 platforms, 5 feeds on free account).
Check format of RSS feed
Validate RSS feed
Test!

Create /posts/ for posts

Currently posts are in root, best to 'namespace' them in /posts/

Create status template

Create a status template that makes sense as a standalone status update, with a unique URL.

Keep in mind that the URL should be generated automatically in the future (timestamp like this YYYYMMDD-hhmm-ss ie 20171215-1258-40) and should be same as date field in front matter.

URL would be /status/20171215-1258-40/

Streamline documentation on www.groundwork.rocks

Documentation needs rewriting on www.groundwork.rocks.

Set up indie web sign in

https://indieweb.org/How_to_set_up_web_sign-in_on_your_own_domain

Install semantic-git-commit-cli

Install semantic-git-commit-cli to make semantic-release more reliable.

Create webmention functionality

We’ll have no comments here, it’s a local website for local people 😉

IndieWeb webmention:
https://indieweb.org/webmention

W3C webmention:
https://www.w3.org/TR/webmention/

Webmention validator:
https://webmention.rocks/

Implementing Webmentions on Perch
https://allinthehead.com/retro/378/implementing-webmentions

Parsing webmentions
https://adactio.com/journal/6495

Web sign in not working Facebook and Google

https://indiewebify.me/validate-rel-me/?url=https%3A%2F%2Fblank.groundwork.rocks%2F

Setup semantic-release to work with Netlify, not publish to npm

Currently, publishing metalsmith-groundwork to npm, so that semantic-release works. But not really suited as an npm package, so best to setup to work just with Netlify.

Stop duplicate assets being copied to build

eg /build/about/assets/

this is a solved problem! Doesn't happen on growdigital.org -- should be easy fix

Fix no images displaying in syndicate.xml feed

No images showing up in /syndicate.xml, which is a combination of statuses and posts excerpts.

Add video collection to www.groundwork.rocks

Create screencasts for functionality of Groundwork/Metalsmith on www.groundwork.rocks

Add microformats

By adding microformatting, will have better search results and previews on RSS feed

Create separate Posts and Status feeds

Creating separate RSS feeds for Posts and Status, so can filter RSS feed for social networks (Status) and RSS feed for default RSS feed (Posts).

Create RSS feed that is post content only

Currently, the RSS feed is the excerpt: front matter field.

Ideally, it should be just the post content only (not the whole page), so that RSS readers display the whole post rather than the excerpt with the link to the whole post.

https://www.npmjs.com/package/metalsmith-feed