https://github.com/edde746/sveltekit-markdown-blog

Static SvelteKit blog with markdown support
https://github.com/edde746/sveltekit-markdown-blog

blog markdown static-site sveltekit

Last synced: 22 days ago
JSON representation

Static SvelteKit blog with markdown support

• Host: GitHub
• URL: https://github.com/edde746/sveltekit-markdown-blog
• Owner: edde746
• Created: 2023-01-04T03:27:34.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T04:57:13.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T16:08:31.401Z (about 1 month ago)
• Topics: blog, markdown, static-site, sveltekit
• Language: Svelte
• Homepage: https://blog-demo-cy4.pages.dev/
• Size: 57.6 KB
• Stars: 12
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sveltekit-markdown-blog

A simple blog that statically generates from markdown files. Built with [SvelteKit](https://kit.svelte.dev/).

## Demo

[**View a live demo here**](https://blog-demo-cy4.pages.dev/)

## Features

- Fully static

- Markdown files

- Dark mode

## Running Locally

```

# Clone the repository

git clone https://github.com/edde746/sveltekit-markdown-blog.git

# Navigate to the project directory

cd sveltekit-markdown-blog

# Install dependencies with pnpm

pnpm install

# Run the development server

pnpm run dev

# Generate the static site

pnpm run build

```

## Adding Posts

To add a new post, create a markdown file in the `posts` directory. The file should have the following front matter at the top:

```md

```

## Deploying

To deploy your blog, you can simply upload the contents of the `build` directory to your web server. Alternatively, you can use a static site hosting service such as [Cloudflare Pages](https://pages.cloudflare.com/).

## License

Use it however you want.