This repository has been archived by the owner on Apr 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): and gemlock plus instruction to setup
- Loading branch information
Showing
4 changed files
with
46 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
2.6.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` | ||
|