4 files changed, 25 insertions(+), 9 deletions(-)
M docs/index.md
R docs/{installation.md => installation-stable.md}
R docs/{recpies/recpies.md => recipes/recipes.md}
M mkdocs.yml
M docs/index.md => docs/index.md +3 -0
@@ 1,5 1,8 @@
# Welcome to the nii-nvim wiki!
+
+
+
nii-nvim is a neovim configuration designed on being lightweight and very
hackable, while also being small and well documented. lightweight and very
hackable, while also being small and well documented. Please note that this
R docs/installation.md => docs/installation-stable.md +3 -3
@@ 1,6 1,6 @@
## Installation Prequisites:
-- Neovim Stable v5.0 or later / Neovim Nightly
+- Neovim
- FZF
- ripgrep
- Python 3
@@ 9,7 9,7 @@
## Migration of older nii-nvim versions
-If you are currently traching chages from the `master` branch,
+If you are currently tracking changes from the `master` branch,
please check out the [Migration guide](https://docs.theoryware.net/nii-nvim/migration-branch/).
## Manual Install
@@ 27,7 27,7 @@ replace the nested `nvim/` dir
```bash
cd ~/.config/
mv ./nvim ./nvim.old
-git clone https://sr.ht/~theorytoe/nii-nvim ./nvim
+git clone https://git.sr.ht/~theorytoe/nii-nvim ./nvim
cd ./nvim
git checkout main
nvim +PackerInstall
R docs/recpies/recpies.md => docs/recipes/recipes.md +0 -0
M mkdocs.yml => mkdocs.yml +19 -6
@@ 3,17 3,16 @@ repo_url: https://sr.ht/~theorytoe/nii-nvim
repo_name: ~theorytoe/nii-nvim
nav:
- Home: index.md
- - Installation: installation.md
+ - Installation:
+ - Stable: installation-stable.md
+ - Nightly: installation-nightly.md
- User Guide:
- Mappings: mappings.md
- Basic configuration: basic-configuration.md
+ - Recipes: 'recipes/recipes.md'
- Philosophy: philosophy.md
- - Recepies: 'recpies/recpies.md'
- # - Advanced Configuration:
- # - Language Server: 'configuration/lsp.md'
- Migration:
- # - Migrating from alpha: migration-tag.md
- - Migrating from master branch: migration-branch.md
+ - Migrating from master branch: migration-branch.md
- Contributing: 'contributing.md'
markdown_extensions:
@@ 40,3 39,17 @@ theme:
primary: light green
accent: cyan
favicon: favicon.png
+
+extra:
+ generator: false
+ social:
+ - icon: material/email
+ link: ~theorytoe/nii-nvim-discuss@lists.sr.ht
+ - icon: material/book-edit
+ link: https://docs.theoryware.net/nii-nvim/contributing/
+ - icon: material/github
+ link: https://github.com/Theory-of-Everything/nii-nvim
+ - icon: material/discord
+ link: https://discord.gg/H6WY7cUkfw
+ - icon: material/message-text
+ link: https://matrix.to/#/#nii-nvim:halogen.city