Skip to content

Latest commit

 

History

History
116 lines (68 loc) · 5.18 KB

README.md

File metadata and controls

116 lines (68 loc) · 5.18 KB
Raw

🌻 Smix

A standards-respecting starter kit for Eleventy. Go Indie.

⚠️ This project is now considered more-or-less complete for the author's needs. Any further enhancements will require a pull request to come from the community.

Reading.

For nice text, there's Typeset. While it adds to the build time, it makes for a more polished reading experience.

It seems people do rely on RSS feeds even in 2022! Cheers to that; there's an Atom feed that is standards-compliant. It understands the published and updated datetime stamps on posts, and uses the RFC822 date format.

Dark mode is included out of the box using a custom media query. (More in future-ready section below).

Date filters such as for friendly dates (10 March 2020) and machine-parseable dates (ISO8601) are available to use via filters.

Discoverability/SEO.

Meta tags for social networks (Open Graph as well as Twitter). This allows for a nice card display when you (or someone else) shares a link to your post or site. Support for content-description meta tag -- this helps decide what text to show for a page/post when shared on social media, as well as in search engines.

Sitemap with changeFrequency -- so bots only come back when they need to. (please also see issue #7). robots.txt is a cherry on the top -- I would also recommend using it to hide your personal picture if so desired.

Writing

Write in Markdown, much loved among developers. If you don't already know it, it's easy to get started. You can also use separate apps and then copy-paste your content into a new file. This allows for focusing on content first, before messing with any technicals. I recommend Bear.

Linking to pages or posts.

postUrl shortcode similar to Jekyll's post_url and link liquid tags:

{% postUrl collections.primary 'on-burnout' %}

Code blocks.

Code blocks are made possible via an Eleventy plugin. Many Prism themes are available to use.

IndieWeb

For those pushing #IndieWeb, some basic Microformats2 support is included. From h-card to understand authorship, h-entry to understand a post, and h-feed to have Microformat feeds. This allows following a website in Microsub readers.

The following post-types are supported:

  • 📄 Article
  • 📔 Note
  • ↪ Reply
  • 📷 Photo

A single microformats2 feeds is offered via h-feed. This includes articles, notes, replies (with or without context), and image(s). These post types also seamlessly work in the Atom feed.

Future-ready.

The CSS is written with upcoming CSS standards in mind. This is made possible thanks to PostCSS. Inclusions: imports, nesting, purge, minification, autoprefixer, custom properties, custom media queries (this makes a dark mode easy to build!), custom selectors, and LCH color coding.

JavaScript is transpiled and bundled via esbuild.

Accessible.

Atkinson font by The Braille Institute is included if you wish to use it. If not, there's a sans, serif, and mono fallback to system fonts.

Care is taken to have good contrast all around.

Should you choose to include some animations, do make use of a custom media query for those who prefer less motion:

/* Prefers reduced motion. */
@media screen and (--rm) {
  .fancy {
    /* Disable animations. */
  }
}

Under The Hood.

Handling JavaScript.

ES Modules are now well supported and you should move to them. In that spirit, we use esbuild.

If you want to bundle a single file and that is the default index.js source, running npm run dev:js is enough.

To allow for page-specific JavaScript files, we have a convenience command to put together a new JS bundle.

npm run dev:jsb --in=portfolio.js --out=portfolio.js

This will create a JS bunlde (hence jsb), entering at src/assets/js/portfolio.js and outputting at dist/assets/js/portfolio.js

Include them in the required page by using the pageJavaScript block:

{% block pageJavascript %}
<script type="module" src="/assets/js/portfolio.js">
{% endblock}

My content here.

Misc Features

  • Prettier and editorconfig for consistent formatting of the codebase.

To-Do

  • Feed per tag (this could easily go into 10s or 100s, but you know, choice is important!)
  • Scheduled blog posts.
  • Re-do development and production docs as needed.

Built off of

Sites that took Smix Eleventy Starter and made something of their own:

  • [Add your site here]