From 718fac7e3e0ebe513d5f9bad895a2921d629bca1 Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Sun, 18 Sep 2022 10:11:24 -0500 Subject: [PATCH] docs: add GHA workflow --- .github/workflows/docs.yml | 17 +++++++++++++++++ docs/index.md | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..b3d5fb9 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,17 @@ +name: docs +on: + push: + branches: + - main +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material \ + mkdocs-git-revision-date-localized-plugin + - run: mkdocs gh-deploy --force + diff --git a/docs/index.md b/docs/index.md index 785dfc8..8a17996 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,7 +23,7 @@ Current Features: Depends on `GNU Make`, obviously and `Python >=3.7`. Wait python?!?!, I'm not `pip` installing some package just to parse my makefile. -I agree, all you need is one file [`.task.mk`](./task.mk). +I agree, all you need is one file [`.task.mk`](https://github.com/daylinmorgan/task.mk/blob/main/task.mk). You can automagically include it with just two additional lines to your `Makefile` (and probably one to your `.gitignore`) and your good to go. ## Setup