Skip to content

Commit 4e8bd95

Browse files
committed
readme
1 parent 639446e commit 4e8bd95

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,25 @@
22

33
Go to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo.
44

5+
## Running locally
6+
7+
You need Ruby and gem before starting, then:
8+
9+
```bash
10+
# install jekyll and bundler
11+
gem install jekyll bundler
12+
13+
# clone the project
14+
git clone https://github.com/aksakalli/jekyll-doc-theme.git
15+
cd jekyll-doc-theme
16+
17+
# install dependencies
18+
bundle install
19+
20+
# run jekyll
21+
jekyll serve
22+
```
23+
524
## License
625

726
Released under [the MIT license](LICENSE).

0 commit comments

Comments
 (0)