Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

metalsmith-groundwork

5.3.10 • Public • Published

Groundwork

Issue Count Dependency Status Build status

Metalsmith blog template. It rocks.

Groundwork logo

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 git@github.com: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

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

More in-depth documentation: www.groundwork.rocks

Issues and features in the Groundwork Roadmap 😍

Contact

Made with pride in Wales 🏴󠁧󠁢󠁷󠁬󠁳󠁿

Deploys by Netlify

Keywords

none

install

npm i metalsmith-groundwork

Downloadsweekly downloads

1

version

5.3.10

license

(MIT OR GPL-3.0)

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability