From e599032860f00093fe3289d8e9606b27718b09ba Mon Sep 17 00:00:00 2001 From: Jeppe Ernst Date: Wed, 18 Apr 2018 22:18:02 +0200 Subject: [PATCH] describe build actions --- README.md | 5 +++++ _scripts/build-then-deploy.sh | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b403cd42..e1af83b5 100644 --- a/README.md +++ b/README.md @@ -26,5 +26,10 @@ If not using Docker, it's **important** that you build the site with `JEKYLL_ENV ### Deploy to FTP with Docker Make sure that you have created a file in `_scripts/` called `config.sh`, (protip: just duplicate the `config-example.sh` file, and set the correct values, you should only need to change username and password.) Then you can build the site ande deploy it by running `docker-compose -f docker-compose-deploy.yml up` +This will execute a Docker container and do the following: +1. Build the site **but** fail if there are any Frontmatter +2. Upload the contents of the `_site/` directory to the FTP server +3. That's it… + ## Structure The contents of the index pages is defined in the frontmatter of the files `_pages/index-.md` \ No newline at end of file diff --git a/_scripts/build-then-deploy.sh b/_scripts/build-then-deploy.sh index 80fd275e..b26d3c08 100644 --- a/_scripts/build-then-deploy.sh +++ b/_scripts/build-then-deploy.sh @@ -8,7 +8,7 @@ normal="\033[0m" source _scripts/config.sh if [[ -z $jekyll_dir || -z $remote_username || -z $remote_password || -z $remote_host || -z $remote_dir ]]; then - echo -e "${error}FAILED: You have ommited one or more values from the config file, see the 'config-example.sh' file for the required values.${normal}" + echo -e "${error}FAILED: You have ommited one or more values from the config file, see the 'config-example.sh' file for the required values. Or maybe you need to create a 'config.sh' file in the '_scripts' directory.${normal}" exit 1 fi