Skip to content

Commit

Permalink
fix(docs): Fix Github actions for building Pages website
Browse files Browse the repository at this point in the history
  • Loading branch information
Ziwi01 committed Jan 7, 2024
1 parent 1af116d commit c5a2ef7
Show file tree
Hide file tree
Showing 37 changed files with 50 additions and 43 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ jobs:
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Install NPM packages
run: npm install
working-directory: docs-web
- name: Build Docusaurus
run: npm run build
working-directory: docs-web
Expand All @@ -42,7 +45,7 @@ jobs:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: builddocs
needs: build-docs
steps:
- name: Deploy to GitHub Pages
id: deployment
Expand Down
2 changes: 1 addition & 1 deletion docs-web/docs/main/customization/20-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Also, it saves/updates them in `./current-versions.yml`. This file is added to `
<details>
<summary><b>Example:</b> Versions output</summary>
<div align="center">
<img src="/versions.png" />
<img src="https://ziwi01.github.io/proveasio/assets/versions.png" />
</div>
</details>
<br />
Expand Down
2 changes: 1 addition & 1 deletion docs-web/docs/main/features/10-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Terminal is ZSH-based, configured with [Oh-my-ZSH](https://github.com/ohmyzsh/oh
<details>
<summary><b>Example:</b> Terminal commandline</summary>
<div align="center">
<img src="/terminal_preview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/terminal_preview.png" />
</div>
</details>
<br />
Expand Down
2 changes: 1 addition & 1 deletion docs-web/docs/main/features/20-tmux.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<details>
<summary><b>Example:</b> TMUX splits</summary>
<div align="center">
<img src="/tmux-overview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/tmux-overview.png" />
</div>
</details>

Expand Down
4 changes: 3 additions & 1 deletion docs-web/docs/usage/10-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ sidebar_position: 1

# Usage

This document describes all the tools and features which I find useful for everyday work including usage scenarios and workflows.
This document describes all the tools and features which I find useful for everyday work including usage scenarios and workflows, tips and tricks and convenient shortucts.

Feel free to browse through it, maybe something will be suitable for your workflow and will bump up the productivity :).
18 changes: 9 additions & 9 deletions docs-web/docs/usage/20-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To go back to `/home/user/projects/ansible`, use something like `z ansible` or `
<details>
<summary><b>Example:</b> Zoxide fuzzy find</summary>
<div align="center">
<img src="./resources/zoxide-ff.gif" />
<img src="https://ziwi01.github.io/proveasio/assets/zoxide-ff.gif" />
</div>
</details>

Expand All @@ -33,7 +33,7 @@ Easily find files with preview using `bfind` alias (uses `fzf`):
<details>
<summary><b>Example:</b> Search file with `bfind`</summary>
<div align="center">
<img src="./resources/bfind.png" />
<img src="https://ziwi01.github.io/proveasio/assets/bfind.png" />
</div>
</details>
<br />
Expand Down Expand Up @@ -67,7 +67,7 @@ There is an alias `btail <file>`, which will use BAT as tail command. This gives
<details>
<summary><b>Example:</b> Tail with `btail`</summary>
<div align="center">
<img src="./resources/btail.png" />
<img src="https://ziwi01.github.io/proveasio/assets/btail.png" />
</div>
</details>

Expand All @@ -82,7 +82,7 @@ Misspelling a command is a real pain in the ass. Here comes the solution. When y
<details>
<summary><b>Example:</b> Correct new branch push with `thefuck`</summary>
<div align="center">
<img src="./resources/thefuck.png" />
<img src="https://ziwi01.github.io/proveasio/assets/thefuck.png" />
</div>
</details>

Expand Down Expand Up @@ -127,7 +127,7 @@ There are two commands to use for this:
<details>
<summary><b>Example:</b> List files with `k`</summary>
<div align="center">
<img src="./resources/terminal-k.png" />
<img src="https://ziwi01.github.io/proveasio/assets/terminal-k.png" />
</div>
</details>
<br />
Expand All @@ -137,7 +137,7 @@ There are two commands to use for this:
<details>
<summary><b>Example:</b> List files with `lsg`</summary>
<div align="center">
<img src="./resources/terminal-lsg.png" />
<img src="https://ziwi01.github.io/proveasio/assets/terminal-lsg.png" />
</div>
</details>

Expand All @@ -156,7 +156,7 @@ Aliases below are just helpers in case something needs to be done from terminal
<details>
<summary><b>Example:</b> Checkout new branch</summary>
<div align="center">
<img src="./resources/git-checkout.png" />
<img src="https://ziwi01.github.io/proveasio/assets/git-checkout.png" />
</div>
</details>

Expand All @@ -167,7 +167,7 @@ Aliases below are just helpers in case something needs to be done from terminal
<details>
<summary><b>Example:</b> Checking git status</summary>
<div align="center">
<img src="./resources/git-status.png" />
<img src="https://ziwi01.github.io/proveasio/assets/git-status.png" />
</div>
</details>

Expand All @@ -192,7 +192,7 @@ All above commands and aliases can be run through [`lazygit`](https://github.com
<details>
<summary><b>Example:</b> Lazy Git interface</summary>
<div align="center">
<img src="./resources/lazygit.png" />
<img src="https://ziwi01.github.io/proveasio/assets/lazygit.png" />
</div>
</details>

Expand Down
2 changes: 1 addition & 1 deletion docs-web/docs/usage/30-tmux.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ TMUX prefix is set to `<C-b>` (ctrl+b) - everything after that is a tmux shortcu
<details>
<summary><b>Example:</b> Tmux window</summary>
<div align="center">
<img src="./resources/tmux-overview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/tmux-overview.png" />
</div>
</details>

Expand Down
14 changes: 7 additions & 7 deletions docs-web/docs/usage/40-vim.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ This will open a directory diff window
<details>
<summary><b>Example:</b> Diff directories</summary>
<div align="center">
<img src="./resources/vim-dirdiff.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-dirdiff.png" />
</div>
</details>
<br />
Expand Down Expand Up @@ -160,7 +160,7 @@ In the example below, there is a search for 'lazygit' with replacement for `Work
<details>
<summary><b>Example:</b> Spectre search</summary>
<div align="center">
<img src="./resources/vim-spectre.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-spectre.png" />
</div>
</details>

Expand All @@ -179,7 +179,7 @@ Unlike Spectre, there is no preview of how the replacement wil look like.
<details>
<summary><b>Example:</b> Ferret search</summary>
<div align="center">
<img src="./resources/vim-ferret.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-ferret.png" />
</div>
</details>
<br />
Expand Down Expand Up @@ -296,7 +296,7 @@ Simply select the text (probably visually with `<Shift>v`), and run `:Tabularize
<details>
<summary><b>Example:</b> Tabular align</summary>
<div align="center">
<img src="./resources/vim-tabular.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-tabular.png" />
</div>
</details>

Expand Down Expand Up @@ -396,7 +396,7 @@ To get changes only for this file, compared to another branch, you can use `:Gvd
<details>
<summary><b>Example:</b> Diffview another branch</summary>
<div align="center">
<img src="./resources/vim-diffview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-diffview.png" />
</div>
</details>

Expand Down Expand Up @@ -458,14 +458,14 @@ Alternatively, you can use `:GV` to browse all commits (`<Enter>` to preview thi
<details>
<summary><b>Example:</b> File history with Diffview</summary>
<div align="center">
<img src="./resources/vim-diffview-history.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-diffview-history.png" />
</div>
</details>
<br />
<details>
<summary><b>Example:</b> File history with GV</summary>
<div align="center">
<img src="./resources/vim-gv.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-gv.png" />
</div>
</details>

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Also, it saves/updates them in `./current-versions.yml`. This file is added to `
<details>
<summary><b>Example:</b> Versions output</summary>
<div align="center">
<img src="/versions.png" />
<img src="https://ziwi01.github.io/proveasio/assets/versions.png" />
</div>
</details>
<br />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Terminal is ZSH-based, configured with [Oh-my-ZSH](https://github.com/ohmyzsh/oh
<details>
<summary><b>Example:</b> Terminal commandline</summary>
<div align="center">
<img src="/terminal_preview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/terminal_preview.png" />
</div>
</details>
<br />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<details>
<summary><b>Example:</b> TMUX splits</summary>
<div align="center">
<img src="/tmux-overview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/tmux-overview.png" />
</div>
</details>

Expand Down
4 changes: 3 additions & 1 deletion docs-web/versioned_docs/version-stable/usage/10-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ sidebar_position: 1

# Usage

This document describes all the tools and features which I find useful for everyday work including usage scenarios and workflows.
This document describes all the tools and features which I find useful for everyday work including usage scenarios and workflows, tips and tricks and convenient shortucts.

Feel free to browse through it, maybe something will be suitable for your workflow and will bump up the productivity :).
18 changes: 9 additions & 9 deletions docs-web/versioned_docs/version-stable/usage/20-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To go back to `/home/user/projects/ansible`, use something like `z ansible` or `
<details>
<summary><b>Example:</b> Zoxide fuzzy find</summary>
<div align="center">
<img src="./resources/zoxide-ff.gif" />
<img src="https://ziwi01.github.io/proveasio/assets/zoxide-ff.gif" />
</div>
</details>

Expand All @@ -33,7 +33,7 @@ Easily find files with preview using `bfind` alias (uses `fzf`):
<details>
<summary><b>Example:</b> Search file with `bfind`</summary>
<div align="center">
<img src="./resources/bfind.png" />
<img src="https://ziwi01.github.io/proveasio/assets/bfind.png" />
</div>
</details>
<br />
Expand Down Expand Up @@ -67,7 +67,7 @@ There is an alias `btail <file>`, which will use BAT as tail command. This gives
<details>
<summary><b>Example:</b> Tail with `btail`</summary>
<div align="center">
<img src="./resources/btail.png" />
<img src="https://ziwi01.github.io/proveasio/assets/btail.png" />
</div>
</details>

Expand All @@ -82,7 +82,7 @@ Misspelling a command is a real pain in the ass. Here comes the solution. When y
<details>
<summary><b>Example:</b> Correct new branch push with `thefuck`</summary>
<div align="center">
<img src="./resources/thefuck.png" />
<img src="https://ziwi01.github.io/proveasio/assets/thefuck.png" />
</div>
</details>

Expand Down Expand Up @@ -127,7 +127,7 @@ There are two commands to use for this:
<details>
<summary><b>Example:</b> List files with `k`</summary>
<div align="center">
<img src="./resources/terminal-k.png" />
<img src="https://ziwi01.github.io/proveasio/assets/terminal-k.png" />
</div>
</details>
<br />
Expand All @@ -137,7 +137,7 @@ There are two commands to use for this:
<details>
<summary><b>Example:</b> List files with `lsg`</summary>
<div align="center">
<img src="./resources/terminal-lsg.png" />
<img src="https://ziwi01.github.io/proveasio/assets/terminal-lsg.png" />
</div>
</details>

Expand All @@ -156,7 +156,7 @@ Aliases below are just helpers in case something needs to be done from terminal
<details>
<summary><b>Example:</b> Checkout new branch</summary>
<div align="center">
<img src="./resources/git-checkout.png" />
<img src="https://ziwi01.github.io/proveasio/assets/git-checkout.png" />
</div>
</details>

Expand All @@ -167,7 +167,7 @@ Aliases below are just helpers in case something needs to be done from terminal
<details>
<summary><b>Example:</b> Checking git status</summary>
<div align="center">
<img src="./resources/git-status.png" />
<img src="https://ziwi01.github.io/proveasio/assets/git-status.png" />
</div>
</details>

Expand All @@ -192,7 +192,7 @@ All above commands and aliases can be run through [`lazygit`](https://github.com
<details>
<summary><b>Example:</b> Lazy Git interface</summary>
<div align="center">
<img src="./resources/lazygit.png" />
<img src="https://ziwi01.github.io/proveasio/assets/lazygit.png" />
</div>
</details>

Expand Down
2 changes: 1 addition & 1 deletion docs-web/versioned_docs/version-stable/usage/30-tmux.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ TMUX prefix is set to `<C-b>` (ctrl+b) - everything after that is a tmux shortcu
<details>
<summary><b>Example:</b> Tmux window</summary>
<div align="center">
<img src="./resources/tmux-overview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/tmux-overview.png" />
</div>
</details>

Expand Down
14 changes: 7 additions & 7 deletions docs-web/versioned_docs/version-stable/usage/40-vim.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ This will open a directory diff window
<details>
<summary><b>Example:</b> Diff directories</summary>
<div align="center">
<img src="./resources/vim-dirdiff.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-dirdiff.png" />
</div>
</details>
<br />
Expand Down Expand Up @@ -160,7 +160,7 @@ In the example below, there is a search for 'lazygit' with replacement for `Work
<details>
<summary><b>Example:</b> Spectre search</summary>
<div align="center">
<img src="./resources/vim-spectre.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-spectre.png" />
</div>
</details>

Expand All @@ -179,7 +179,7 @@ Unlike Spectre, there is no preview of how the replacement wil look like.
<details>
<summary><b>Example:</b> Ferret search</summary>
<div align="center">
<img src="./resources/vim-ferret.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-ferret.png" />
</div>
</details>
<br />
Expand Down Expand Up @@ -296,7 +296,7 @@ Simply select the text (probably visually with `<Shift>v`), and run `:Tabularize
<details>
<summary><b>Example:</b> Tabular align</summary>
<div align="center">
<img src="./resources/vim-tabular.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-tabular.png" />
</div>
</details>

Expand Down Expand Up @@ -396,7 +396,7 @@ To get changes only for this file, compared to another branch, you can use `:Gvd
<details>
<summary><b>Example:</b> Diffview another branch</summary>
<div align="center">
<img src="./resources/vim-diffview.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-diffview.png" />
</div>
</details>

Expand Down Expand Up @@ -458,14 +458,14 @@ Alternatively, you can use `:GV` to browse all commits (`<Enter>` to preview thi
<details>
<summary><b>Example:</b> File history with Diffview</summary>
<div align="center">
<img src="./resources/vim-diffview-history.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-diffview-history.png" />
</div>
</details>
<br />
<details>
<summary><b>Example:</b> File history with GV</summary>
<div align="center">
<img src="./resources/vim-gv.png" />
<img src="https://ziwi01.github.io/proveasio/assets/vim-gv.png" />
</div>
</details>

Expand Down

0 comments on commit c5a2ef7

Please sign in to comment.