diff options
author | Egor Tensin <Egor.Tensin@gmail.com> | 2020-05-07 00:00:53 +0300 |
---|---|---|
committer | Egor Tensin <Egor.Tensin@gmail.com> | 2020-05-07 00:00:53 +0300 |
commit | d0d9d36b10d6c13d929f1c6f619a011ffc5b7591 (patch) | |
tree | 20a1eaef5e9e0de0035d306e985cf990283e8f1b | |
parent | workflows/test.yml: better step names & linting (diff) | |
download | jekyll-docker-d0d9d36b10d6c13d929f1c6f619a011ffc5b7591.tar.gz jekyll-docker-d0d9d36b10d6c13d929f1c6f619a011ffc5b7591.zip |
README: update
-rw-r--r-- | README.md | 19 | ||||
-rw-r--r-- | docker-compose.yml | 2 |
2 files changed, 6 insertions, 15 deletions
@@ -3,6 +3,10 @@ jekyll-docker ![This even works?](https://github.com/egor-tensin/jekyll-docker/workflows/This%20even%20works%3F/badge.svg) +Develop your Jekyll project in a Docker container, without installing all the +dependencies on the host. +Or don't. + | Feature | Command | ---------------------- | ---------------------------------------------- | Install [ruby-install] | `make ruby-install && make ruby-install/clean` @@ -61,21 +65,6 @@ Examples Bring everything down: make docker/down - -Notes ------ - -This project was supposed to be included as a submodule in my Jekyll projects' -repositories. -I would then `cd` to Jekyll project's directory and run something like - - make -f jekyll-docker/Makefile docker/up - -and I'd get a Docker container running Jekyll, without actually bothering to -install everything locally. -This goal was achieved, but I also noticed that "out-of-tree" builds were -actually possible, hence the introduction of the PROJECT_DIR parameter, and the -slight crazyness with the two separate images. License ------- diff --git a/docker-compose.yml b/docker-compose.yml index 5ed8a86..cb70877 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,3 +1,5 @@ +# About the two images... +# # I had conflicting requirements: # * make Makefile available during the build to avoid code duplication, # * make out-of-tree builds possible (i.e. this directory, along with Makefile, |