Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.
/ slinkity Public archive

To eleventy and beyond! The all-in-one tool for templates where you want them, component frameworks where you need them ๐Ÿš€

License

Notifications You must be signed in to change notification settings

slinkity/slinkity

Repository files navigation

License: MIT Twitter: slinkitydotdev

Slinkity

โš ๏ธ This project is no longer maintained. The project owner (@bholmesdev) now works on Astro full-time. If you want to build component-driven content sites, give Astro a try! If you're committed to 11ty and want to use client components, consider 11ty's WebC project.

About

Slinkity is a simple way to handle styles and component frameworks on your 11ty site. Once installed, this:

  • ๐Ÿš€ Unlocks component frameworks like React for writing page templates and layout templates. Turn an existing .html or .liquid file into a .jsx file, and you're off to the componentized races.
  • ๐Ÿ”– Includes powerful shortcodes to insert components into existing pages. Add a line like this to your markdown, HTML, Nunjucks, etc, and watch the magic happen: {% react 'path/to/component' %}
  • ๐Ÿ’ง Hydrates these components when and how you want. Use component frameworks as a static template to start, and opt-in to shipping JS as needed with our partial hydration helpers.
  • ๐Ÿ’… Bundles all your resources with the power of Vite. Use your favorite CSS preprocessor, JS minifier, and more with minimal config.

Technologies used

Slinkity stands on the shoulders of giants. You can think of Slinkity as the "glue" binding 2 tools together:

  1. Eleventy: a static site generator with a rich feature set for fetching data, composing layouts, and inserting content with "shortcodes."
  2. Vite: a bundler that takes the boilerplate out of your set up. It'll compile JS component frameworks, handle CSS preprocessors with little-to-no config (say, SCSS and PostCSS), and show dev changes on-the-fly using hot module replacement (HMR).

Getting started

Use our CLI command to spin up a Slinkity site: npm init slinkity. This demos our core functionality while staying as lean as possible.

To learn more, and explore adding Slinkity to existing 11ty projects...