Skip to content
This repository was archived by the owner on Apr 22, 2021. It is now read-only.

Commit e8dee3e

Browse files
committed
docs(readme): and gemlock plus instruction to setup
1 parent b71c666 commit e8dee3e

File tree

4 files changed

+46
-20
lines changed

4 files changed

+46
-20
lines changed

.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.6.3

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@ gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
3434

3535
gem "jekyll-remote-theme"
3636
gem "jekyll-paginate"
37+
38+
gem "jekyll-theme-slate", "~> 0.1.1"

Gemfile.lock

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
addressable (2.6.0)
5-
public_suffix (>= 2.0.2, < 4.0)
4+
addressable (2.7.0)
5+
public_suffix (>= 2.0.2, < 5.0)
66
colorator (1.1.0)
7-
concurrent-ruby (1.1.5)
7+
concurrent-ruby (1.1.7)
88
em-websocket (0.5.1)
99
eventmachine (>= 0.12.9)
1010
http_parser.rb (~> 0.6.0)
1111
eventmachine (1.2.7)
1212
eventmachine (1.2.7-x64-mingw32)
13-
ffi (1.11.1)
14-
ffi (1.11.1-x64-mingw32)
13+
ffi (1.13.1)
14+
ffi (1.13.1-x64-mingw32)
1515
forwardable-extended (2.6.0)
1616
http_parser.rb (0.6.0)
1717
i18n (0.9.5)
1818
concurrent-ruby (~> 1.0)
19-
jekyll (3.8.6)
19+
jekyll (3.8.7)
2020
addressable (~> 2.4)
2121
colorator (~> 1.0)
2222
em-websocket (~> 0.5)
@@ -29,7 +29,7 @@ GEM
2929
pathutil (~> 0.9)
3030
rouge (>= 1.7, < 4)
3131
safe_yaml (~> 1.0)
32-
jekyll-feed (0.12.1)
32+
jekyll-feed (0.13.0)
3333
jekyll (>= 3.7, < 5.0)
3434
jekyll-paginate (1.1.0)
3535
jekyll-remote-theme (0.4.2)
@@ -48,23 +48,21 @@ GEM
4848
listen (~> 3.0)
4949
kramdown (1.17.0)
5050
liquid (4.0.3)
51-
listen (3.1.5)
52-
rb-fsevent (~> 0.9, >= 0.9.4)
53-
rb-inotify (~> 0.9, >= 0.9.7)
54-
ruby_dep (~> 1.2)
51+
listen (3.2.1)
52+
rb-fsevent (~> 0.10, >= 0.10.3)
53+
rb-inotify (~> 0.9, >= 0.9.10)
5554
mercenary (0.3.6)
56-
minima (2.5.0)
57-
jekyll (~> 3.5)
55+
minima (2.5.1)
56+
jekyll (>= 3.5, < 5.0)
5857
jekyll-feed (~> 0.9)
5958
jekyll-seo-tag (~> 2.1)
6059
pathutil (0.16.2)
6160
forwardable-extended (~> 2.6)
62-
public_suffix (3.1.1)
63-
rb-fsevent (0.10.3)
64-
rb-inotify (0.10.0)
61+
public_suffix (4.0.5)
62+
rb-fsevent (0.10.4)
63+
rb-inotify (0.10.1)
6564
ffi (~> 1.0)
66-
rouge (3.6.0)
67-
ruby_dep (1.5.0)
65+
rouge (3.22.0)
6866
rubyzip (1.3.0)
6967
safe_yaml (1.0.5)
7068
sass (3.7.4)
@@ -73,9 +71,9 @@ GEM
7371
rb-fsevent (~> 0.9, >= 0.9.4)
7472
rb-inotify (~> 0.9, >= 0.9.7)
7573
thread_safe (0.3.6)
76-
tzinfo (1.2.5)
74+
tzinfo (1.2.7)
7775
thread_safe (~> 0.1)
78-
tzinfo-data (1.2019.2)
76+
tzinfo-data (1.2020.1)
7977
tzinfo (>= 1.0.0)
8078
wdm (0.1.1)
8179

readme.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# GoodDocs Project -- Site
2+
3+
Currently this repository serves as the homepage for [The Good Docs Project](https://thegooddocsproject.dev/)
4+
5+
6+
## Building Jekyll
7+
8+
There is an assumption here you have setup a ruby environment previously. Those instructions unfortunately are out of scope for this project.
9+
10+
The current ruby version is `2.6.3` and Bundle `2.1.4`. If you make updates to the `Gemlock` file please update this readme.
11+
12+
```shell
13+
# install gems
14+
gem install
15+
16+
# install pacakge using bundle
17+
bundle install
18+
19+
# Build the content -- this sources the markdown and writes html to `_site/`
20+
bundle exec jekyll build
21+
22+
# Takes the build at `_site/` and mounts it to a web-server
23+
bundle exec jekyll serve
24+
```
25+

0 commit comments

Comments
 (0)