https://github.com/maybethisisru/smix-test

https://github.com/maybethisisru/smix-test

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/maybethisisru/smix-test
• Owner: MaybeThisIsRu
• License: mit
• Created: 2021-04-12T06:37:52.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-12T06:41:07.000Z (about 5 years ago)
• Last Synced: 2025-02-15T08:12:38.305Z (over 1 year ago)
• Language: JavaScript
• Size: 1.41 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🌻 Smix

__A gulp-based starter for Static Site Generators, preconfigured for @11ty/eleventy and Forestry CMS__

## Framework

* ♥ Eleventy 0.11.0 out of the box

  * Date filters for a friendly version such as `10 March 2020`, and ISO8601 (also RFC822 compatible)

  * `getUrl` shortcode similar to Jekyll's `post_url` and `link` liquid tags

  * Custom rendering engine for HTML files - `Liquid v9`

    * Adds support for missing filters such as `where` and improves performance

* 🛋 Preconfigured for [Forestry CMS](https://forestry.io/) _and_ [Netlify](https://netlify.com/).

  * For Forestry...

    * Sign up, log in, look for the `Deploy admin` option.

    * Everything else is set up for you already. :)

  * For Netlify...

    * Sign up, log in, add a `New site`.

    * Out of the box staging builds include Forestry drafts whereas production builds do not.

* 💁Indie publishing and reading experience

  * microformats2 support for `h-card`, `h-entry`, and `h-feed` out of the box

* 👩‍💻 Modern JavaScript

  * Transpilation via Babel

    * Support for `ES2015` JavaScript syntax

    * Support for `ES2017` `async`/`await` syntax

  * Module bundling via Browserify

* 🎨 PostCSS

  * Includes: imports, nesting, purge, minification, autoprefixer

  * TailwindCSS, configured to strip out unused classes from production builds

  * Easily build a dark mode using the included `dm` screen type: `dm:bg-gray-900`

* 🔍 SEO and more

  * Meta tags for social networks (Open Graph/Twitter)

  * Sitemap with `changeFrequency`; `robots.txt` (please also see [issue #7](https://github.com/hirusi/smix-eleventy-starter/issues/7))

  * An Atom feed with support for both `published` and `updated` dates on articles

  * Support for `content-description` meta tag

* 📖 A sane fonts setup

  * The `font-sans` class is configured to use system-default fonts

  * Include fonts locally for enhanced privacy of your visitors

  * `typeset` for professional looking content

* 💪 Minified assets on production

* 📔 Prettier and editorconfig

* 🔧 Modular gulp task files for easy configuration and modification

## To-Do

* Reload automatically after our assets change (filed [issue here](https://github.com/11ty/eleventy/issues/1125), waiting for response/PR approval). Please reload manually for now.

* Webmentions, incoming and outgoing, only from/to other IndieWeb sites

* System default serif font class

* Scheduled blog posts

* Lazy-load images

* Responsive images

## How to Use

### Local Development

* `nvm use`

* `npm install`

* `npm run dev`

* Open `localhost:8080` on your browser

### Production

* `npm run prod`