summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2021-06-20 22:48:14 -0700
committerGitHub <noreply@github.com>2021-06-21 01:48:14 -0400
commit53296d11d981b607ee643c49033f378842b964dc (patch)
treeb14abe30877cc2f3e440d0ba3afe1627681d0dc8
parent06071d5abfb8b6715768e8bbb1236be49c02cf46 (diff)
ci: fix doc deploy action (#507)
Fix for simple mkdocs deploy action. I'll likely rewrite this if I add versioning, which I probably will.
-rw-r--r--.github/workflows/docs.yml5
-rw-r--r--README.md2
2 files changed, 4 insertions, 3 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 67d6c829..f9faaa71 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -23,5 +23,6 @@ jobs:
python-version: 3.x
- run: pip install mkdocs-material
- run: pip install mdx_truly_sane_lists
- - run: cd docs/
- - run: mkdocs gh-deploy --force
+ - run: |
+ cd docs/
+ mkdocs gh-deploy --force
diff --git a/README.md b/README.md
index 5c696a87..f14d1303 100644
--- a/README.md
+++ b/README.md
@@ -226,7 +226,7 @@ The release binaries are packaged with shell auto-completion files for bash, fis
You can run bottom using `btm`.
-For help on flags, use `btm -h` for a quick overview or `btm --help` for more details.
+For help on flags, use `btm -h` for a quick overview or `btm --help` for more details. You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/).
## Configuration