mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-21 00:25:42 +02:00
docs: Deploy both stable & unstable docs to github pages
This commit is contained in:
parent
1c9f2a23a6
commit
b0b010a0e9
3 changed files with 13 additions and 2 deletions
4
.github/workflows/build_documentation.yml
vendored
4
.github/workflows/build_documentation.yml
vendored
|
@ -44,12 +44,12 @@ jobs:
|
||||||
name: nix-community
|
name: nix-community
|
||||||
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
|
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
|
||||||
|
|
||||||
- run: nix build .#docs --show-trace
|
- run: ./build-docs.sh
|
||||||
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v3
|
uses: actions/upload-pages-artifact@v3
|
||||||
with:
|
with:
|
||||||
path: "result/share/doc"
|
path: "docs-build"
|
||||||
|
|
||||||
- name: Deploy to GitHub Pages
|
- name: Deploy to GitHub Pages
|
||||||
id: deployment
|
id: deployment
|
||||||
|
|
|
@ -233,6 +233,8 @@ be.
|
||||||
Documentation is available on this project's GitHub Pages page:
|
Documentation is available on this project's GitHub Pages page:
|
||||||
[https://nix-community.github.io/nixvim](https://nix-community.github.io/nixvim)
|
[https://nix-community.github.io/nixvim](https://nix-community.github.io/nixvim)
|
||||||
|
|
||||||
|
The stable documentation is also available at [https://nix-community.github.io/nixvim/stable](https://nix-community.github.io/nixvim/stable).
|
||||||
|
|
||||||
If the option `enableMan` is set to `true` (by default it is), man pages will also
|
If the option `enableMan` is set to `true` (by default it is), man pages will also
|
||||||
be installed containing the same information, they can be viewed with `man nixvim`.
|
be installed containing the same information, they can be viewed with `man nixvim`.
|
||||||
|
|
||||||
|
|
9
build-docs.sh
Executable file
9
build-docs.sh
Executable file
|
@ -0,0 +1,9 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
mkdir -p docs-build
|
||||||
|
nix build github:nix-community/nixvim#docs
|
||||||
|
cp -r result/share/doc docs-build
|
||||||
|
nix build github:nix-community/nixvim/nixos-23.11#docs
|
||||||
|
cp -r result/share/doc docs-build/stable
|
Loading…
Add table
Add a link
Reference in a new issue