📚 docs(vscodium): added about section, setup section and some overview images

This commit is contained in:
Sergio Laín 2024-08-12 12:48:31 +02:00
parent fe6451bebe
commit b4a8f19e01
No known key found for this signature in database
GPG key ID: 8429B2EE312F8150
4 changed files with 71 additions and 11 deletions

View file

@ -1,43 +1,48 @@
<div align="center">
<a href=""><img src="./title.png"></a>
<a href="#"><img src="./title.png"></a>
</div>
<div align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="80%"/><br>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="90%"/><br>
</div>
<div align="center">
<a href="#herb--about"><img width="190px" src="../../../../.github/assets/category-images/dotfiles-about.png"></a>
<a href="#gear--config"><img width="190px" src="../../../../.github/assets/category-images/dotfiles-config.png"></a>
<a href="#camera--gallery"><img width="190px" src="../../../../.github/assets/category-images/dotfiles-gallery.png"></a>
<a href="#keyboard--binds"><img width="190px" src="../../../../.github/assets/category-images/dotfiles-binds.png"></a>
<a href="#herb--about"><img width="190px" src="https://raw.githubusercontent.com/Matt-FTW/dotfiles/main/.github/assets/category-images/dotfiles-about.png"></a>
<a href="#wrench--setup"><img width="190px" src="https://raw.githubusercontent.com/Matt-FTW/dotfiles/main/.github/assets/category-images/dotfiles-setup.png"></a>
<a href="#camera--gallery"><img width="190px" src="https://raw.githubusercontent.com/Matt-FTW/dotfiles/main/.github/assets/category-images/dotfiles-gallery.png"></a>
</div>
# :herb: <samp>About</samp>
### Plugins
[VSCodium](https://vscodium.com/) is my fallback editor in case I cannot use neovim for some specific task, which most of the time doesn't happen but its good to have a backup option.
It's basically the binaries of [VS Code](https://code.visualstudio.com/) but without all of the Microsoft bullshit built on top of it. It functions exactly the same as VS Code, although there's some extensions such as Copilot which needs the telemetry data to function, but as I dont use it, I dont really care.
The extensions I use are the following:
- [alefragnani.project-manager](https://github.com/alefragnani/vscode-project-manager)
- [amodio.toggle-excluded-files](https://github.com/eamodio/vscode-toggle-excluded-files)
- [astro-build.astro-vscode](https://github.com/withastro/vscode-astro)
- [bmalehorn.vscode-fish](https://github.com/bmalehorn/vscode-fish)
- [bradlc.vscode-tailwindcss](https://github.com/bradlc/vscode-tailwindcss)
- [BrandonKirbyson.vscode-animations](https://github.com/BrandonKirbyson/vscode-animations)
- [Catppuccin.catppuccin-vsc](https://github.com/catppuccin/catppuccin-vscode)
- [charliermarsh.ruff](https://github.com/charliermarsh/ruff)
- [Codeium.codeium](https://github.com/VSCodeVim/vscode-vim)
- [DavidAnson.vscode-markdownlint](https://github.com/DavidAnson/vscode-markdownlint)
- [yzhang.markdown-all-in-one](https://github.com/yzhang-gh/vscode-markdown)
- [dbaeumer.vscode-eslint](https://github.com/dbaeumer/vscode-eslint)
- [drcika.apc-extension](https://github.com/drcika/apc-extension)
- [dsznajder.es7-react-js-snippets](https://github.com/dsznajder/es7-react-js-snippets)
- [eamodio.gitlens](https://github.com/eamodio/vscode-gitlens)
- [esbenp.prettier-vscode](https://github.com/esbenp/vscode-prettier)
- [ibm.output-colorizer](https://github.com/IBM-Cloud/vscode-log-output-colorizer)
- [ExodiusStudios.comment-anchors](https://github.com/ExodiusStudios/vscode-comment-anchors)
- [formulahendry.code-runner](https://github.com/formulahendry/vscode-code-runner)
- [ms-vscode-remote.remote-ssh](https://github.com/Microsoft/vscode-remote-release)
- [golang.go](https://github.com/filipw/vscode-go)
- [humao.rest-client](https://github.com/humao/rest-client)
- [jrebocho.vscode-random](https://github.com/jrebocho/vscode-random)
@ -53,8 +58,8 @@
- [stivo.tailwind-fold](https://github.com/stivoat/tailwind-fold)
- [streetsidesoftware.code-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker)
- [sumneko.lua](https://github.com/sumneko/vscode-lua)
- [catppuccin.catppuccin-vsc-icons](https://github.com/catppuccin/vscode-icons)
- [svelte.svelte-vscode](https://github.com/sveltejs/vscode-svelte)
- [thang-nm.catppuccin-perfect-icons](https://github.com/thang-nm/catppuccin-perfect-icons)
- [timonwong.shellcheck](https://github.com/timonwong/vscode-shellcheck)
- [tobias-z.vscode-harpoon](https://github.com/tobias-z/vscode-harpoon)
- [usernamehw.errorlens](https://github.com/usernamehw/vscode-errorlens)
@ -64,9 +69,64 @@
- [yandeu.five-server](https://github.com/yandeu/five-server)
- [YoavBls.pretty-ts-errors](https://github.com/YoavBls/pretty-ts-errors)
- [ziglang.vscode-zig](https://github.com/ziglang/vscode-zig)
- [yutengjing.vscode-colorize-plus](https://github.com/tjx666/vscode-colorize)
- [barbosshack.crates-io](https://github.com/BarbossHack/crates-io)
- [pucelle.vscode-css-navigation](https://github.com/pucelle/vscode-css-navigation)
- [tamasfe.even-better-toml](https://github.com/tamasfe/taplo)
- [kisstkondoros.vscode-gutter-preview](https://github.com/kisstkondoros/gutter-preview)
- [emilast.logfilehighlighter](https://github.com/emilast/vscode-logfile-highlighter)
- [asvetliakov.vscode-neovim](https://github.com/vscode-neovim/vscode-neovim)
# :gear: <samp>Config</samp>
# :wrench: <samp>Setup</samp>
### :package: Extensions Installation
VSCodium comes with a CLI client where you can export the extensions list you have installed, or import the list of extensions you want to install.
In the repo there's a binary that can be used to install a list of extensions from a text file. [Here it is](../../../../.local/bin/installCodiumExtensions).
Firstly, here's how you can export your list of extensions:
```bash
vscodium --list-extensions > extensions.txt
```
After you have the file, here's how to install them:
```bash
~/.local/bin/installCodiumExtensions <extensions-file>
```
If you want my list, [check it out](../extensions.txt).
### :package: Native Neovim Integration
At this point, I dont think I could use VSCodium without it. Here's how you can do it:
Firstly, install the [vscode-neovim extension](https://github.com/vscode-neovim/vscode-neovim). There's the [vim extension](https://github.com/VSCodeVim/Vim) as well, but that's just an emulation meanwhile this one uses neovim under the hood and you can even load part of your configuration which is amazing.
Next up, edit the [settings.json file](../settings.json) and find the line that says `"vscode-neovim.neovimExecutablePaths.linux": "/home/matt/.local/share/bob/nvim-bin/nvim"` and change the path to your personal neovim binary.
Finally, if you want part of your neovim configuration on VSCodium, open neovim and enable the extra called `util.vscode`. After that, open VSCodium and you should be able to use some neovim plugins out of the box such as flash.nvim, and have part of the keybindings working. If you wanna enable a plugin for VSCodium you can do so by adding this options in your plugin table: `vscode = true`.
If you wanna enable some keybindings, make sure to open the vscode.lua extra file and find the autocmd where you can add new keybindings to call the VSCodium API. An example of a keybinding:
```lua
map("n", "<leader>xx", vscode_action("workbench.actions.view.problems"))
```
If you also want something like which-key, you can install the [which-key plugin](https://github.com/VSpaceCode/vscode-whichkey). Check their docs to see how to add new keybindings.
# :camera: <samp>Gallery</samp>
# :keyboard: <samp>Binds</samp>
| **Overview** |
| ------------------------------- |
| ![overview-1](./overview-1.png) |
| **Flash.nvim inside VSCodium** |
| ------------------------------- |
| ![overview-2](./overview-2.png) |
| **Multiple Terminals** |
| ------------------------------- |
| ![overview-3](./overview-3.png) |

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 187 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 886 KiB