https://github.com/arzyu/jekyll-dev

Using livereload for gem-based Jekyll theme development.
https://github.com/arzyu/jekyll-dev

jekyll jekyll-theme livereload

Last synced: about 2 months ago
JSON representation

Using livereload for gem-based Jekyll theme development.

• Host: GitHub
• URL: https://github.com/arzyu/jekyll-dev
• Owner: arzyu
• Created: 2017-06-09T16:48:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-14T14:27:04.000Z (about 5 years ago)
• Last Synced: 2024-10-11T09:41:28.921Z (3 months ago)
• Topics: jekyll, jekyll-theme, livereload
• Language: TypeScript
• Size: 28.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jekyll-dev

Using livereload for gem-based Jekyll theme development.

## Installation

```shell

npm install -g jekyll-dev

```

## Usage & Workflow

1. Create a jekyll site and a theme:

   ```shell

   ## create a site named jekyll-site

   jekyll new jekyll-site

   ## create a theme named jekyll-theme-sample

   jekyll new-theme jekyll-theme-sample

   ```

2. Add the theme to your site's `Gemfile`

   ```ruby

   ## replace default theme `gem "minima", ...`

   gem "jekyll-theme-sample", :path => "../jekyll-theme-sample"

   ```

3. Add the following to your site's `_config.yml` to activate the theme:

   ```yaml

   ## replace default `theme: minima`

   theme: jekyll-theme-sample

   ```

4. Start to develop:

   ```shell

   cd jekyll-site

   jekyll-dev

   ```

   > Notice:

   > You may need to tweak your site and theme to solve some console errors. See `sample/` of this repository.

## License

MIT