-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from slipstream8125/main
Documentation about StratVIM
- Loading branch information
Showing
5 changed files
with
62 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: What is StratVIM? | ||
--- | ||
|
||
![StratVIM working on StratOS](./images/StratVIM.png) | ||
|
||
# Introduction: | ||
StratVIM is a custom neovim configuration made for StratOS. | ||
|
||
# What is it made using? | ||
It is made using [lazy.nvim](https://github.com/folke/lazy.nvim) as its plugin manager. It contains some extra plugins like telescope-themes, cheatsheet.nvim etc for the convenience of the user. | ||
|
||
# What features does StratVIM have ? | ||
|
||
- Theme switching using [telescope-themes](https://github.com/andrew-george/telescope-themes) | ||
|
||
- Lazy loaded using [lazy.nvim](https://github.com/folke/lazy.nvim) | ||
|
||
- Git management via [lazygit.nvim](https://github.com/kdheepak/lazygit.nvim) | ||
|
||
- Dashboard made using [dashboard.nvim](https://github.com/nvimdev/dashboard-nvim) | ||
|
||
- Terminal support in nvim using [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim) | ||
|
||
- Customized cmdline using [noice.nvim](https://github.com/folke/noice.nvim) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Installing StratVIM | ||
--- | ||
|
||
# Prerequisites: | ||
- Install [Neovim v0.9+](https://github.com/neovim/neovim). | ||
- Make sure you have [npm](https://npmjs.com/), [node](https://nodejs.org/), [cargo](https://www.rust-lang.org/tools/install), [pip](https://pypi.org/project/pip/), [python](https://www.python.org/), [git](https://git-scm.com/) and [lazygit](https://github.com/jesseduffield/lazygit) installed in your system. | ||
|
||
# How to install ? | ||
|
||
- Clone the [StratVIM](https://github.com/StratOS-Linux/StratVIM) git repository into the .config folder: | ||
|
||
```bash | ||
git clone https://github.com/lugvitc/StratVIM.git ~/.config/nvim | ||
``` | ||
|
||
# Updating plugins in StratVIM : | ||
To update plugins in StratVIM, use the `:Lazy` command inside StratVIM: | ||
|
||
```bash | ||
:Lazy sync | ||
``` | ||
|
||
# Uninstalling StratVIM : | ||
To uninstall StratVIM and its plugins: | ||
|
||
- First remove the nvim folder from the .config directory : | ||
```bash | ||
rm -r ~/.config/nvim | ||
``` | ||
|
||
- Remove the plugins located in `.local/share/nvim` aswell : | ||
```bash | ||
rm -rf ~/.local/share/nvim | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.