https://github.com/sharu725/yuyutsu

A minimal Sveltekit template with a sidebar.
https://github.com/sharu725/yuyutsu

markdown mdsvex sveltekit sveltekit-template sveltekit-theme

Last synced: 17 days ago
JSON representation

A minimal Sveltekit template with a sidebar.

• Host: GitHub
• URL: https://github.com/sharu725/yuyutsu
• Owner: sharu725
• License: mit
• Created: 2022-02-14T07:26:17.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-07T01:52:08.000Z (2 months ago)
• Last Synced: 2024-10-12T19:29:05.864Z (about 1 month ago)
• Topics: markdown, mdsvex, sveltekit, sveltekit-template, sveltekit-theme
• Language: Svelte
• Homepage: https://yuyutsu.sveltethemes.dev
• Size: 657 KB
• Stars: 43
• Watchers: 2
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/sharu725/yuyutsu)

# Yuyutsu Sveltekit Theme

A minimal Sveltekit markdown theme with a sidebar.

![Yuyutsu Sveltekit Theme screenshot](https://raw.githubusercontent.com/sharu725/yuyutsu/master/static/yuyutsu-sveltekit-theme.png)

## Usage (might change in the future)

- fork the repo.

- run `npm install` to install all the dependencies.

- run `npm run dev` to start a dev server.

- run `npm run build` to build the production site.

- the theme uses `@sveltejs/adapter-vercel` but you can change it if you're using a different platform to host the site.

## Features

- minimal layout with a nice sidebar.

- markdown blog posts and pages with layout support.

- categorize blog posts

- basic search engine optimization

## Speed

![yuyutsu-lighthouse-score](https://user-images.githubusercontent.com/8033084/163713979-3dfd23dd-c861-4387-816c-a08f0f70819e.jpg)

## Todo

- [x] use mdsvex for all pages/posts

- [x] paginate posts

- [ ] style html elements (links, buttons, images, table, iframe etc)

- [x] SEO

- [ ] a darkmode switch

- [x] ready to host on Vercel

## Contributions

- fork the repo

- make changes and create a pull request

## License

[MIT](https://github.com/sharu725/yuyutsu/blob/master/LICENSE.md)