Local dev (#64)

* Added `bpkg.json` for quick command reference.

* Added Docker for local development environment:

- Added `docker-compose.yml` with `jekyll/jekyll` image
- Updated `_config.yml` exclude to include compose file
- Updated `bpkg.json` to include docker commands
- Updated `README.md` to provide Docker Environment section

* Added Jekyll minimal theme to Docker image.

- Added `Dockerfile` with `gem install` for required Jekyll theme
- Updated `docker-compose.yml` to use new `Dockerfile`
- Updated `_config.yml` exclude to include `dev` directory

* Fixed failed Jekyll build:

- Updated `Dockerfile` to add `webrick` install
- Remove `nil` valued layout from `atom.xml` and `rss.xml`

* Added `bpkg` to Docker image:

- Updated `Dockerfile` to install `bpkg` and dependencies
- Updated `bpkg.json` to include commands for Docker `bpkg`

* Added `bpkg` Rake commands.

* Correct Docker environment:

- Update `bpkg.json` command `docker` to expose service ports
- Update `Dockerfile` installation of `curl` removing virtual option

Author: samlikins

.gitignore

@@ -3,6 +3,7 @@
 
 _site/*
 _theme_packages/*
+.jekyll-cache/*
 
 Thumbs.db
 .DS_Store

README.md

@@ -3,18 +3,36 @@
 `bpkg` is a lightweight bash package manager.
 This repository contains the source code of it's homepage.
 
-## Links:
+## Links
 
 * [`bpkg` homepage][home];
 * [`bpkg` source code on GitHub][hub];
 * [`bpkg` organization on GitHub][org];
 
+## `bpkg` Commands
+
+To assist in working with this project, A `bpkg.json` file has been included with commonly used project commands.  The provided commands can be executed using the following format:
+
+```bash
+$ bpkg run [COMMAND]
+```
+
+In the remainder of this document, if there is a accompanying `bpkg` _command_ it will be listed as follows:
+
+> **BPKG:** `[COMMAND]`
+
+## Docker Environment
+
+This environment is not necessary to use if you'd rather run everything directly on your host system.  This environment is provided however, to facilitate all the required components for building and development of `bpkg` site.  There are associated `bpkg` commands to interact with the Docker environment.
+
 ## Dependencies
 
 This website was made with the [Jekyll][jekyll] engine, so it depends on a few
 Ruby Gems. To install them, run the following command.
 
-    $ gem install jekyll
+```bash
+$ gem install jekyll
+```
 
 It might take a while to finish, but once it does you're ready to go.
 
@@ -28,19 +46,29 @@ of possible commands (thanks to [this great quickstart on Jekyll][tuto]):
 
 ---
 
-    $ rake preview
+```bash
+$ rake preview
+```
+
+> **BPKG:** `preview`<br />
+> **BPKG:** `docker-preview`
 
 Builds the entire site to a local folder `_site` and launches a webserver to
 preview it.
 
-To see the full site, point your browser to `localhost:40000`.
+To see the full site, point your browser to `localhost:4000`.
 
 If you make any changes on any files, it will regenerate the website
 automatically.
 
 ---
 
-    $ rake post title="Hello, World!"
+```bash
+$ rake post title="Hello, World!"
+```
+
+> **BPKG:** `post title="Hello, World!"`<br />
+> **BPKG:** `docker-post title="Hello, World!"`
 
 Creates a new post. It will create a file `_posts/YYYY-MM-DD-title.md`, where
 the date is the current, by default.
@@ -50,11 +78,21 @@ site.
 
 ---
 
-    $ rake page name="about"
+```bash
+$ rake page name="about"
+```
+
+> **BPKG:** `page name="about"`<br />
+> **BPKG:** `docker-page name="about"`
 
 Creates a new page. It will create the file `./about/index.html`.
 
-    $ rake page name="about.html"
+```bash
+$ rake page name="about.html"
+```
+
+> **BPKG:** `page name="about.html"`<br />
+> **BPKG:** `docker-page name="about.html"`
 
 Alternative way to create a new page, on this case it will be `./about.html`.
 
@@ -78,9 +116,8 @@ This site uses [Jekyll Bootstrap][boots] with a heavily customized version of
 [org]:     https://github.com/bpkg
 [jekyll]:  http://jekyllrb.com/
 [tuto]:    http://jekyllbootstrap.com/usage/jekyll-quick-start.html
+[posts]:   http://jekyllrb.com/docs/posts/
 [intro]:   http://jekyllbootstrap.com/lessons/jekyll-introduction.html
 [boots]:   http://jekyllbootstrap.com/
 [theme]:   https://github.com/jekyllbootstrap/theme-the-program
 [saito]:   http://css.studiomohawk.com/
-[posts]:   http://jekyllrb.com/docs/posts/
-

_config.yml

@@ -39,7 +39,16 @@ highlighter : rouge # code highlighter
 # For more see: http://jekyllrb.com/docs/permalinks/
 permalink: /pkg/:title
 
-exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
+exclude: [
+  ".rbenv-version",
+  ".rvmrc",
+  "bpkg.json",
+  "changelog.md",
+  "dev/",
+  "docker-compose.yml",
+  "Rakefile",
+  "README.md"
+]
 
 # The production_url is only used when full-domain names are needed
 # such as sitemap.txt

bpkg.json

@@ -0,0 +1,25 @@
+{
+  "name": "bpkg/bpkg.github.io",
+  "description": "Homepage for the bpkg project ",
+  "commands": {
+    "create":         "mkdir .jekyll-cache; mkdir _site",
+    "build":          "jekyll build $@",
+    "clean":          "rm -Rf .jekyll-cache/* _site/*",
+    "preview":        "rake preview",
+    "post":           "rake post $@",
+    "page":           "rake page $@",
+
+    "docker":         "docker-compose run --rm --service-ports jekyll $@",
+
+    "docker-shell":   "bpkg run docker /bin/bash",
+    "docker-jekyll":  "bpkg run docker jekyll $@",
+    "docker-rake":    "bpkg run docker rake $@",
+    "docker-bpkg":    "bpkg run docker bpkg $@",
+
+    "docker-build":   "bpkg run docker-jekyll build $@",
+    "docker-clean":   "bpkg run docker-bpkg run clean",
+    "docker-preview": "bpkg run docker-rake preview",
+    "docker-post":    "bpkg run docker-rake post $@",
+    "docker-page":    "bpkg run docker-rake page $@"
+  }
+}

dev/Dockerfile

@@ -0,0 +1,12 @@
+FROM jekyll/jekyll:latest
+
+RUN gem install \
+    webrick \
+    jekyll-theme-minimal
+
+RUN apk add --no-cache \
+    curl
+
+RUN wget -O - get.bpkg.sh | bash
+
+CMD []

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3"
+
+services:
+    jekyll:
+        build:
+            context: ./dev/
+        volumes:
+            - ./:/srv/jekyll:Z
+        ports:
+          - "4000:4000"
+        stdin_open: true
+        tty: true

feed/atom.xml

@@ -1,5 +1,4 @@
 ---
-layout: nil
 title : Atom Feed
 ---
 <?xml version="1.0" encoding="utf-8"?>

feed/rss.xml

@@ -1,5 +1,4 @@
 ---
-layout: nil
 title : RSS Feed
 ---