diff options
| author | Gokul Soumya | 2022-03-14 02:46:40 +0000 |
|---|---|---|
| committer | GitHub | 2022-03-14 02:46:40 +0000 |
| commit | 85492e587cc27ba9783c8380683660a0f4423ff4 (patch) | |
| tree | b65d0024e2656d11242c39ec0785e1d444226797 | |
| parent | 1ac576f2b3ab3b3b1c398c57e1269682e6f63f3e (diff) | |
Deploy docs for master separately (#1783)
* Deploy docs for master separately
* Output docs for every tagged release
* Update .github/workflows/gh-pages.yml
Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
| -rw-r--r-- | .github/workflows/gh-pages.yml | 16 | ||||
| -rw-r--r-- | book/src/SUMMARY.md | 2 | ||||
| -rw-r--r-- | book/src/title-page.md | 15 |
3 files changed, 32 insertions, 1 deletions
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index bf3488c8..223f8450 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -4,6 +4,8 @@ on: push: branches: - master + tags: + - '*' jobs: deploy: @@ -18,10 +20,22 @@ jobs: # mdbook-version: '0.4.8' - run: mdbook build book + + - name: Set output directory + run: | + OUTDIR=$(basename ${{ github.ref }}) + echo "OUTDIR=$OUTDIR" >> $GITHUB_ENV - name: Deploy uses: peaceiris/actions-gh-pages@v3 - if: github.ref == 'refs/heads/master' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book/book + destination_dir: ./${{ env.OUTDIR }} + + - name: Deploy stable + uses: peaceiris/actions-gh-pages@v3 + if: startswith(github.ref, 'refs/tags/') with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./book/book diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index a8f165c0..9e15eee3 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -1,5 +1,7 @@ # Summary +[Helix](./title-page.md) + - [Installation](./install.md) - [Usage](./usage.md) - [Keymap](./keymap.md) diff --git a/book/src/title-page.md b/book/src/title-page.md new file mode 100644 index 00000000..c182a753 --- /dev/null +++ b/book/src/title-page.md @@ -0,0 +1,15 @@ +# Helix + +Docs for bleeding edge master can be found at +[https://docs.helix-editor.com/master](https://docs.helix-editor.com/master). + +See the [usage] section for a quick overview of the editor, [keymap] +section for all available keybindings and the [configuration] section +for defining custom keybindings, setting themes, etc. + +Refer the [FAQ] for common questions. + +[FAQ]: https://github.com/helix-editor/helix/wiki/FAQ +[usage]: ./usage.md +[keymap]: ./keymap.md +[configuration]: ./configuration.md |