https://github.com/levivoelz/jekyll-starter
Starter kit with Jekyll, Vite, TypeScript, SolidJS, and i18n support.
https://github.com/levivoelz/jekyll-starter
Last synced: 8 months ago
JSON representation
Starter kit with Jekyll, Vite, TypeScript, SolidJS, and i18n support.
- Host: GitHub
- URL: https://github.com/levivoelz/jekyll-starter
- Owner: levivoelz
- Created: 2023-10-06T21:21:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T21:22:01.000Z (about 2 years ago)
- Last Synced: 2025-01-01T09:21:44.499Z (9 months ago)
- Language: Ruby
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jekyll Vite Starter Kit
This starter kit uses [Vite](https://vitejs.dev/) to bundle assets and [Jekyll](https://jekyllrb.com/) to generate static pages. It's a great combination for building fast and modern static websites. You can use vite to bundle React, Vue, Svelte, or vanilla JS/TS along with CSS.
Jekyll Plugins: [jekyll-vite](https://github.com/ElMassimo/jekyll-vite)
## Getting Started
### Prerequisites
- [tmux](https://github.com/tmux/tmux/wiki)
- [overmind](https://github.com/DarthSim/overmind)
### Installation
1. Clone the repo
```sh
git clone https://github.com/levivoelz/jekyll-vite-starter-kit.git
```
2. Install dependencies
```sh
# macOS
brew install tmux
brew install overmind
bundle install
npm install
# Ubuntu
sudo apt install tmux
sudo apt install overmind
bundle install
npm install
```
## Usage
### Development
```sh
npm start
```
or if your prefered flavor is Ruby
```sh
bundle exec rake start
```
### Documentation
For additional info on how to work with jekyll-vite please review the [ jekyll-vite documentation](https://github.com/ElMassimo/jekyll-vite)
i18n is also supported, for more info on how to work with i18n please review the [jekyll-multiple-languages-plugin documentation](https://github.com/kurtsson/jekyll-multiple-languages-plugin)