on master help sign in
Deploy docs for master separately (#1783)
85492e5Gokul Soumya
.github/workflows/gh-pages.yml+15−1
@@ -4,6 +4,8 @@ on:
4 push:
4 push:
5 branches:
5 branches:
6 - master
6 - master
7+ tags:
8+ - '*'
7
9
8jobs:
10jobs:
9 deploy:
11 deploy:
@@ -18,10 +20,22 @@ jobs:
18 # mdbook-version: '0.4.8'
20 # mdbook-version: '0.4.8'
19
21
20 - run: mdbook build book
22 - run: mdbook build book
23+
24+ - name: Set output directory
25+ run: |
26+ OUTDIR=$(basename ${{ github.ref }})
27+ echo "OUTDIR=$OUTDIR" >> $GITHUB_ENV
21
28
22 - name: Deploy
29 - name: Deploy
23 uses: peaceiris/actions-gh-pages@v3
30 uses: peaceiris/actions-gh-pages@v3
31+ with:
32+ github_token: ${{ secrets.GITHUB_TOKEN }}
33+ publish_dir: ./book/book
34+ destination_dir: ./${{ env.OUTDIR }}
35+
36+ - name: Deploy stable
37+ uses: peaceiris/actions-gh-pages@v3
24− if: github.ref == 'refs/heads/master'
38+ if: startswith(github.ref, 'refs/tags/')
25 with:
39 with:
26 github_token: ${{ secrets.GITHUB_TOKEN }}
40 github_token: ${{ secrets.GITHUB_TOKEN }}
27 publish_dir: ./book/book
41 publish_dir: ./book/book
book/src/SUMMARY.md+2
@@ -1,5 +1,7 @@
1# Summary
1# Summary
2
2
3+[Helix](./title-page.md)
4+
3- [Installation](./install.md)
5- [Installation](./install.md)
4- [Usage](./usage.md)
6- [Usage](./usage.md)
5 - [Keymap](./keymap.md)
7 - [Keymap](./keymap.md)
book/src/title-page.mdnew file+15
@@ -0,0 +1,15 @@
1+# Helix
2+
3+Docs for bleeding edge master can be found at
4+[https://docs.helix-editor.com/master](https://docs.helix-editor.com/master).
5+
6+See the [usage] section for a quick overview of the editor, [keymap]
7+section for all available keybindings and the [configuration] section
8+for defining custom keybindings, setting themes, etc.
9+
10+Refer the [FAQ] for common questions.
11+
12+[FAQ]: https://github.com/helix-editor/helix/wiki/FAQ
13+[usage]: ./usage.md
14+[keymap]: ./keymap.md
15+[configuration]: ./configuration.md