Swyxkit

Overview

SwyxKit is a starter for SvelteKit blogs that provides a lightweight and opinionated setup. It is built on SvelteKit 1.0 and Mdsvex, and has been verified to work on Netlify and Vercel. Some key features include a GitHub Issues-based CMS, support for Twitter/YouTube embeds, admonitions and bleed layouts, and minor design and user experience touches. The theme is fast and secure, with performance optimizations and security headers in place. SwyxKit is easy to install and deploy, and has been used by various users in the wild.

Features

• Light+Dark mode
• GitHub-Issues-driven blog with index
• Blog content pulled from the GitHub Issues API
• Comment and Reaction system from GitHub Issues, rendered with Utterances
• Shortcodes for embedding Tweets and YouTube videos
• Consumes markdown/MDSveX with syntax highlighting
• RSS and Sitemap with caching
• Performance and security optimizations

Installation

To install SwyxKit, follow these steps:

1. Clone the SwyxKit repository from GitHub.
2. Install the necessary dependencies by running npm install in the project directory.
3. Set up your GitHub repository to sync with GitHub Issues. This will serve as your CMS.
4. Configure the necessary environment variables, such as GH_TOKEN, to enable features like Utterances and error handling.
5. Customize the theme to fit your needs by modifying the configuration files and adding your own content.
6. Deploy the SwyxKit project to your preferred hosting platform, such as Netlify or Vercel.

Summary

SwyxKit is a highly customizable and opinionated starter theme for SvelteKit blogs. It provides a range of features, from light+dark mode and GitHub-Issues-driven content management to support for Twitter/YouTube embeds and synta