An open API service indexing awesome lists of open source software.

https://github.com/loke-dev/sveltekit-mdsvex-blog-template

MDsveX blog starter template built with Sveltekit & Tailwind
https://github.com/loke-dev/sveltekit-mdsvex-blog-template

blog journal mdsvex playwright portfolio portfolio-website remark starter svelte sveltekit tailwindcss template typescript vite vitest

Last synced: 3 months ago
JSON representation

MDsveX blog starter template built with Sveltekit & Tailwind

Awesome Lists containing this project

README

          

# SvelteKit MDSvex Blog Template

A blazing fast, modern blog template built with SvelteKit, MDSvex, and TailwindCSS. Perfect for developers, writers, and creators who want a performant, SEO-friendly personal website with a built-in blog.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Floke-dev%2Fsveltekit-mdsvex-blog-template)

![Image](https://github.com/user-attachments/assets/88d8ac01-220c-4c25-a3bd-27bc1ae8825a)

## โœจ Features

- **โšก๏ธ Lightning Fast**: Built on SvelteKit for exceptional performance and quick page loads
- **๐Ÿ“ MDSvex Integration**: Write your blog posts in Markdown with full Svelte component support
- **๐ŸŽจ Modern Styling**: Powered by TailwindCSS with typography plugin for beautiful, responsive design
- **๐Ÿ” SEO Optimized**:
- Built-in meta tags and structured data
- Automatic sitemap generation
- Social media preview cards
- **๐Ÿ“ฑ Responsive Design**: Looks great on all devices, from mobile to desktop
- **๐Ÿ“Š Analytics Ready**: Vercel Analytics integration out of the box
- **๐Ÿงช Testing Setup**: Comprehensive testing with Vitest and Playwright
- **๐Ÿท๏ธ Content Organization**: Tag-based categorization for easy content discovery
- **๐Ÿš€ Easy Deployment**: Deploy anywhere that supports SvelteKit, optimized for Vercel

## ๐Ÿš€ Quick Start

### Using the Template

1. Click the "Use this template" button on GitHub
2. Clone your new repository:
```bash
git clone
cd
```

### Installation

```bash
pnpm install
```

### Development

Start the development server:

```bash
pnpm dev
```

Visit `http://localhost:5173` to see your site.

## ๐Ÿ“ Writing Blog Posts

Create new `.svx` files in `src/posts/` with this frontmatter:

```markdown
---
title: Your Post Title
description: A brief description of your post
date: 2023-06-15
published: true
tag: svelte
---

Your content here...
```

## โš™๏ธ Configuration

1. Update `src/variables.ts` with your information
2. Customize the site layout in `src/routes/+layout.svelte`
3. Modify the homepage in `src/routes/+page.svelte`

## ๐Ÿงช Testing

```bash
pnpm test # Run unit tests
pnpm test:watch # Run tests in watch mode
pnpm test:coverage # Run tests with coverage
pnpm test:e2e # Run end-to-end tests
```

## ๐Ÿ—๏ธ Production

Build for production:

```bash
pnpm build
```

Preview the production build:

```bash
pnpm preview
```

## ๐Ÿ“ฆ Deployment

This template is optimized for deployment on Vercel and will work out of the box. It's also compatible with any platform that supports SvelteKit.

## ๐Ÿ“„ License

MIT

## โค๏ธ Credits

Created by [Loke](https://github.com/loke-dev) and the SvelteKit community.