From 79b34055d05e970ec34bb87d7bdcf6880acaebc2 Mon Sep 17 00:00:00 2001 From: Sy Brand Date: Wed, 21 Aug 2019 13:02:58 +0100 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47e52ca..84c91a9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# Eleventy Action +# GitHub Action for Eleventy +Use this action to build your static website with [Eleventy](https://www.11ty.io/). + +To use it, create a `.github/workflows/eleventy_build.yml` file which [uses this repository](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idsteps) as an action. + +Here's an example which builds the site with this action, then deploys to GitHub Pages with [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages): + +```yaml +name: Eleventy Build +on: [push] + +jobs: + build_deploy: + runs-on: ubuntu-18.04 + steps: + - uses: actions/checkout@master + - name: Build + uses: TartanLlama/actions-eleventy@v1.0 + - name: Deploy + uses: peaceiris/actions-gh-pages@v1.1.0 + env: + PUBLISH_DIR: _site + PUBLISH_BRANCH: gh-pages + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + +You can pass additional arguments to `eleventy` through the `args` option: + +```yaml +- name: Build + uses: TartanLlama/actions-eleventy@v1.0 + with: + args: +```