Skip to content

Commit

Permalink
[Blog] Add install and run instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
komidawi committed Dec 19, 2024
1 parent 8ef5c5b commit 71ed9eb
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,43 @@

## Install

- Node
- \[Linux] `nvm` is fine
- \[Windows] `nvm-for-windows` is fine
- Ruby + Jekyll
- \[Linux] `rbenv` is fine
- \[Windows] don't use `rbenv-for-windows` - it's bugged
- Use RubyInstaller - see [Official Jekyll Guide](https://jekyllrb.com/docs/installation/windows/)
### Prerequisites

#### Node
- \[Linux] `nvm` is fine
- \[Windows] `nvm-for-windows` is fine

```shell
nvm -v
```

#### Ruby + Jekyll
- \[Linux] `rbenv` is fine
- \[Windows] don't use `rbenv-for-windows` - it's bugged
- Use RubyInstaller - see [Official Jekyll Guide](https://jekyllrb.com/docs/installation/windows/)

```shell
ruby -v
```

### Installation

```shell
gem install jekyll bundler
bundle exec jekyll -v
```

## Run

- `bundle exec jekyll start`
- or shorter: `bundle exec jekyll s`
```shell
bundle exec jekyll serve
```

or shorter:

```shell
bundle exec jekyll s
```

Remember to add `bundle exec` before all `jekyll` commands ([docs](https://jekyllrb.com/docs/usage/)).

Expand Down

0 comments on commit 71ed9eb

Please sign in to comment.