Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jekyll-gh-pages-local-setup #58

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,29 @@ sensical.
Local development can be previewed by installing Jekyll or by using Docker. We
think the latter experience is easier to setup with more consistent behavior.

### Jekyll setup

1. [Install Ruby Installer](https://rubyinstaller.org/downloads/)
2. To confirm the installation, in your terminal, change directory to where you have cloned this repository
(or a fork of it)
```shell
ruby -v
gem -v
```
3. **To install bundler jekyll:**
```shell
gem install bundler jekyll
```
4. **To run the jekyll site :**
```shell
jekyll serve
```
-The server may be slow .It will take some time to run

For detailed explaination of setting up github pages locally using Jekyll
1. https://training.nih-cfde.org/en/latest/General-Tools/Web-Development/Jekyll_Tutorial/#step-2-build-jekyll-site-using-template-from-github
2. https://jekyllrb.com/docs/


### Docker Compose setup

Expand All @@ -114,7 +137,7 @@ think the latter experience is easier to setup with more consistent behavior.
```
- Once running successfully, you can access the site in your browser at
[localhost:4000](http://localhost:4000/)
6. **Stop the container:** To stop the app from running, simply open an another
4. **Stop the container:** To stop the app from running, simply open an another
instance of terminal and type
```shell
docker compose down
Expand Down