Skip to content

Commit

Permalink
Merge pull request #6 from slipstream8125/main
Browse files Browse the repository at this point in the history
Documentation about StratVIM
  • Loading branch information
slipstream8125 authored Jun 24, 2024
2 parents a5dc7fd + f9e68b9 commit 1c34858
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/content/docs/strata/Ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ StratOS has out-of-the-box (OOTB) support for Ubuntu :
sudo brl fetch ubuntu
```

After installing Ubuntu as an strata on StratOS, we can run an update on its repos for safety:
After installing Ubuntu as a stratum on StratOS, we can run an update on its repos for safety:


```bash
Expand Down
26 changes: 26 additions & 0 deletions src/content/docs/tools/StratVIM/01-introduction.md
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)

35 changes: 35 additions & 0 deletions src/content/docs/tools/StratVIM/02-installation.md
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.
3 changes: 0 additions & 3 deletions src/content/docs/tools/StratVIM/introduction.md

This file was deleted.

0 comments on commit 1c34858

Please sign in to comment.