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>
This commit is contained in:
parent
1ac576f2b3
commit
85492e587c
16
.github/workflows/gh-pages.yml
vendored
16
.github/workflows/gh-pages.yml
vendored
@ -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
|
||||
|
@ -1,5 +1,7 @@
|
||||
# Summary
|
||||
|
||||
[Helix](./title-page.md)
|
||||
|
||||
- [Installation](./install.md)
|
||||
- [Usage](./usage.md)
|
||||
- [Keymap](./keymap.md)
|
||||
|
15
book/src/title-page.md
Normal file
15
book/src/title-page.md
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user