Skip to content

Commit 986e177

Browse files
paulopattopaulopatto
authored
feat(wiki): Creates action to sync docs (#53)
Automatiza a criação da wiki com docs do projeto
1 parent 51cfb08 commit 986e177

File tree

6 files changed

+174
-0
lines changed

6 files changed

+174
-0
lines changed

‎.github/workflows/sync-wiki.yaml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Sincronizar Wiki
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "docs/**"
9+
10+
jobs:
11+
sync-wiki:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout código fonte
15+
uses: actions/checkout@v3
16+
17+
- name: Configurar Git
18+
run: |
19+
git config --global user.name "GitHub Action"
20+
git config --global user.email "action@github.com"
21+
22+
- name: Clone Wiki
23+
run: git clone https://github.com/${{ github.repository }}.wiki.git wiki
24+
# git clone https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git wiki
25+
26+
- name: Get commit info
27+
id: commit_info
28+
run: |
29+
COMMIT_HASH=$(git rev-parse HEAD)
30+
COMMIT_TITLE=$(git log -1 --pretty=%s)
31+
echo "hash=$COMMIT_HASH" >> $GITHUB_OUTPUT
32+
echo "title=$COMMIT_TITLE" >> $GITHUB_OUTPUT
33+
34+
- name: Copy & Sync
35+
run: |
36+
cp -r docs/* wiki/
37+
cd wiki
38+
git add .
39+
git diff-index --quiet HEAD || git commit -m "docs: Add documentation to '${{ steps.commit_info.outputs.title }}' (ref: ${{ steps.commit_info.outputs.hash }})" && git push
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+

‎docs/Home.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Welcome to the dotfiles wiki!
2+

‎docs/nvim/Avante.nvim.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## About Avante.nvim
2+
3+
[avante.nvim](https://github.com/yetone/avante.nvim) is a Neovim plugin designed to emulate the behaviour of the Cursor AI IDE. It provides users with AI-driven code suggestions and the ability to apply these recommendations directly to their source files with minimal effort.
4+
5+
With this the #28 become outdated
6+
7+
## Key Bindings
8+
9+
The following key bindings are available for use with `avante.nvim`:
10+
11+
| Key Binding | Description |
12+
| ----------------------------------------- | -------------------------------------------- |
13+
| <kbd>Leader</kbd><kbd>a</kbd><kbd>a</kbd> | show sidebar |
14+
| <kbd>Leader</kbd><kbd>a</kbd><kbd>r</kbd> | refresh sidebar |
15+
| <kbd>Leader</kbd><kbd>a</kbd><kbd>f</kbd> | switch sidebar focus |
16+
| <kbd>Leader</kbd><kbd>a</kbd><kbd>e</kbd> | edit selected blocks |
17+
| <kbd>c</kbd><kbd>o</kbd> | choose ours |
18+
| <kbd>c</kbd><kbd>t</kbd> | choose theirs |
19+
| <kbd>c</kbd><kbd>a</kbd> | choose all theirs |
20+
| <kbd>c</kbd><kbd>0</kbd> | choose none |
21+
| <kbd>c</kbd><kbd>b</kbd> | choose both |
22+
| <kbd>c</kbd><kbd>c</kbd> | choose cursor |
23+
| <kbd>]</kbd><kbd>x</kbd> | move to previous conflict |
24+
| <kbd>[</kbd><kbd>x</kbd> | move to next conflict |
25+
| <kbd>[</kbd><kbd>[</kbd> | jump to previous codeblocks (results window) |
26+
| <kbd>]</kbd><kbd>]</kbd> | jump to next codeblocks (results windows) |
27+
28+
> [!NOTE]
29+
>
30+
> If you are using `lazy.nvim`, then all keymap here will be safely set, meaning if `<leader>aa` is already binded, then avante.nvim won't bind this mapping.
31+
> In this case, user will be responsible for setting up their own. See [notes on keymaps](https://github.com/yetone/avante.nvim/wiki#keymaps-and-api-i-guess) for more details.
32+
33+
## Commands
34+
35+
| Command | Description | Examples |
36+
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
37+
| `:AvanteAsk [question] [position]` | Ask AI about your code. Optional `position` set window position and `ask` enable/disable direct asking mode | `:AvanteAsk position=right Refactor this code here` |
38+
| `:AvanteBuild` | Build dependencies for the project |
39+
| `:AvanteChat` | Start a chat session with AI about your codebase. Default is `ask`=false |
40+
| `:AvanteEdit` | Edit the selected code blocks |
41+
| `:AvanteFocus` | Switch focus to/from the sidebar |
42+
| `:AvanteRefresh` | Refresh all Avante windows |
43+
| `:AvanteSwitchProvider` | Switch AI provider (e.g. openai) |
44+
| `:AvanteShowRepoMap` | Show repo map for project's structure |
45+
| `:AvanteToggle` | Toggle the Avante sidebar |
46+
47+
## Highlight Groups
48+
49+
| Highlight Group | Description | Notes |
50+
| --------------------------- | --------------------------------------------- | -------------------------------------------- |
51+
| AvanteTitle | Title | |
52+
| AvanteReversedTitle | Used for rounded border | |
53+
| AvanteSubtitle | Selected code title | |
54+
| AvanteReversedSubtitle | Used for rounded border | |
55+
| AvanteThirdTitle | Prompt title | |
56+
| AvanteReversedThirdTitle | Used for rounded border | |
57+
| AvanteConflictCurrent | Current conflict highlight | Default to `Config.highlights.diff.current` |
58+
| AvanteConflictIncoming | Incoming conflict highlight | Default to `Config.highlights.diff.incoming` |
59+
| AvanteConflictCurrentLabel | Current conflict label highlight | Default to shade of `AvanteConflictCurrent` |
60+
| AvanteConflictIncomingLabel | Incoming conflict label highlight | Default to shade of `AvanteConflictIncoming` |
61+
| AvantePopupHint | Usage hints in popup menus | |
62+
| AvanteInlineHint | The end-of-line hint displayed in visual mode | |
63+
64+
See [highlights.lua](./lua/avante/highlights.lua) for more information
65+

‎docs/nvim/Home.md‎

Whitespace-only changes.

‎docs/nvim/terminal-maanger.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Terminal manager for (neo)vim
2+
3+
Source: https://github.com/voldikss/vim-floaterm
4+
5+
![91380268-2cd24d00-e857-11ea-8dbd-d39a0bbb105e](https://github.com/user-attachments/assets/7fe56071-2eab-4f37-a4bc-f06ec183ea52)
6+
7+
### Features ✨
8+
9+
- Manage multiple terminal instances
10+
- Customizable terminal window style
11+
- Switch/preview floating terminal buffers using fuzzy-finder plugins such as [denite.nvim](https://github.com/Shougo/denite.nvim) or [fzf](https://github.com/junegunn/fzf), etc.
12+
- Use with other external command-line tools(ranger, fzf, ripgrep etc.)
13+
- Use as a custom task runner for [asynctasks.vim](https://github.com/skywind3000/asynctasks.vim) or [asyncrun.vim](https://github.com/skywind3000/asyncrun.vim)
14+
15+
#### Keybindings ⌨️
16+
17+
- new term: `<leader>nt`: New Term
18+
- toggle floaterm: `<leader>tt`: Toggle Term
19+
20+
#### Install dependencies 📦 :
21+
22+
- `pip3 install neovim-remote` to allow floaterm to open windows inside neovim.
23+
24+
### REFERENCES 📚 :
25+
26+
[Youtube Video: Vim Plugin Highlight: floaterm! Floating terminals!](https://youtu.be/QzlwC-AUY-U?si=cDlvadhVSd3VcxeM)
27+

‎docs/tmux/Home.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Tmux configs
2+
3+
[TMux](https://tmux.github.io/) is a "terminal multiplexer: it enables a number of terminals (or windows), each running a separate program, to be created, accessed, and controlled from a single screen. TMux may be detached from a screen and continue running in the background, then later reattached."
4+
5+
tmux is an ISC-licensed alternative to [GNU Screen](https://wiki.archlinux.org/title/GNU_Screen). Although similar, there are many differences between the programs, as noted on the [tmux FAQ page](https://github.com/tmux/tmux/wiki/FAQ).
6+
7+
## Installation
8+
9+
[Install](https://github.com/tmux/tmux/wiki/Installing) the tmux package.
10+
11+
Ubuntu:
12+
13+
```sh
14+
sudo apt install tmux
15+
```
16+
17+
Fedora:
18+
19+
```sh
20+
sudo dnf install tmux
21+
```
22+
23+
macOS:
24+
25+
```sh
26+
brew install tmux
27+
```
28+
29+
## Configuration
30+
31+
By default, tmux looks for user-specific configuration at `$XDG_CONFIG_HOME/tmux/tmux.conf` followed by `$HOME/.config/tmux/tmux.conf`, as of 3.2. A global configuration file may be provided at /etc/tmux.conf though by default Arch does not ship such a file.
32+
33+
---
34+
35+
## References
36+
37+
- [Arch Linux: TMux manual page](https://wiki.archlinux.org/title/tmux#Clipboard_integration)
38+

0 commit comments

Comments
 (0)