diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 0000000..ec1cf33 --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +2.6.3 diff --git a/Gemfile b/Gemfile index ebfdc23..7472efa 100644 --- a/Gemfile +++ b/Gemfile @@ -34,3 +34,5 @@ gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform? gem "jekyll-remote-theme" gem "jekyll-paginate" + +gem "jekyll-theme-slate", "~> 0.1.1" diff --git a/Gemfile.lock b/Gemfile.lock index 2c05718..6df1255 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,22 +1,22 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.6.0) - public_suffix (>= 2.0.2, < 4.0) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) colorator (1.1.0) - concurrent-ruby (1.1.5) + concurrent-ruby (1.1.7) em-websocket (0.5.1) eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) eventmachine (1.2.7) eventmachine (1.2.7-x64-mingw32) - ffi (1.11.1) - ffi (1.11.1-x64-mingw32) + ffi (1.13.1) + ffi (1.13.1-x64-mingw32) forwardable-extended (2.6.0) http_parser.rb (0.6.0) i18n (0.9.5) concurrent-ruby (~> 1.0) - jekyll (3.8.6) + jekyll (3.8.7) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) @@ -29,7 +29,7 @@ GEM pathutil (~> 0.9) rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-feed (0.12.1) + jekyll-feed (0.13.0) jekyll (>= 3.7, < 5.0) jekyll-paginate (1.1.0) jekyll-remote-theme (0.4.2) @@ -48,23 +48,21 @@ GEM listen (~> 3.0) kramdown (1.17.0) liquid (4.0.3) - listen (3.1.5) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - ruby_dep (~> 1.2) + listen (3.2.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.3.6) - minima (2.5.0) - jekyll (~> 3.5) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (3.1.1) - rb-fsevent (0.10.3) - rb-inotify (0.10.0) + public_suffix (4.0.5) + rb-fsevent (0.10.4) + rb-inotify (0.10.1) ffi (~> 1.0) - rouge (3.6.0) - ruby_dep (1.5.0) + rouge (3.22.0) rubyzip (1.3.0) safe_yaml (1.0.5) sass (3.7.4) @@ -73,9 +71,9 @@ GEM rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) thread_safe (0.3.6) - tzinfo (1.2.5) + tzinfo (1.2.7) thread_safe (~> 0.1) - tzinfo-data (1.2019.2) + tzinfo-data (1.2020.1) tzinfo (>= 1.0.0) wdm (0.1.1) diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..ae5e48d --- /dev/null +++ b/readme.md @@ -0,0 +1,25 @@ +# GoodDocs Project -- Site + +Currently this repository serves as the homepage for [The Good Docs Project](https://thegooddocsproject.dev/) + + +## Building Jekyll + +There is an assumption here you have setup a ruby environment previously. Those instructions unfortunately are out of scope for this project. + +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. + +```shell +# install gems +gem install + +# install pacakge using bundle +bundle install + +# Build the content -- this sources the markdown and writes html to `_site/` +bundle exec jekyll build + +# Takes the build at `_site/` and mounts it to a web-server +bundle exec jekyll serve +``` +