docs: add wiki

5 files changed, 94 insertions, 1 deletions

diff --git a/.github/README.md b/.github/README.md
new file mode 120000
index 0000000..6ddb271
--- /dev/null
+++ b/.github/README.md
@@ -0,0 +1 @@
+wiki/dotfiles/index.md
\ No newline at end of file
diff --git a/.vimrc b/.vimrc
index 51fb9c1..6ec5116 100644
--- a/.vimrc
+++ b/.vimrc
@@ -114,7 +114,7 @@ vnoremap < <gv
 vnoremap > >gv
 
 " Vimwiki
-let g:vimwiki_list = [{'path': '~/Documents/Projects/env/', 'syntax': 'markdown', 'ext': '.md'}]
+let g:vimwiki_list = [{'path': '~/wiki/', 'syntax': 'markdown', 'ext': '.md'}]
 nnoremap <Leader>c :let &cole=(&cole == 2) ? 0 : 2 <bar> echo 'conceallevel ' . &cole <CR>
 
 function! VimwikiLinkHandler(link)
diff --git a/wiki/dotfiles/index.md b/wiki/dotfiles/index.md
new file mode 100644
index 0000000..1088a39
--- /dev/null
+++ b/wiki/dotfiles/index.md
@@ -0,0 +1,11 @@
+# dotfiles
+This repo contains configs, dotfiles and environment settings for my Arch linux setup.
+Github repo: [dotfiles](https://github.com/eug-vs/dotfiles)
+Owner: [eug-vs](https://github.com/eug-vs/)
+
+## Wiki
+ - [Vim-related stuff](vim.md) (my minimal `nvim` and `vifm` configuration)
+ - [Xorg](xorg.md) (featuring `i3 Window Manager` config)
+
+## TODO
+ - resolve old relative links
diff --git a/wiki/dotfiles/vim.md b/wiki/dotfiles/vim.md
new file mode 100644
index 0000000..16bf2c3
--- /dev/null
+++ b/wiki/dotfiles/vim.md
@@ -0,0 +1,64 @@
+# Vim
+
+After having used [Spacevim](https://spacevim.org/) for quite a while,
+I've decided to switch back to classic Neovim and keep configuration as tight and minimal as possible.
+
+I keep my configuration in casual `~/.vimrc` which is sourced by Neovim in `init.vim`.
+
+## Vim-plug
+Some functionality still requires me to install a few plugins, and `vim-plug` is my plugin manager of choice.
+Intsallation (note that command differs from default):
+```bash
+curl -fLo ~/.config/nvim/autoload/plug.vim --create-dirs https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
+```
+
+All plugins are listed in [`config/nvim/vim-plug/plugins.vim`](vfile:../config/nvim/vim-plug/plugins.vim) and sourced from `init.vim` directly (before `~/.vimrc`).
+Current list of plugins:
+ - Defx - I like to always keep a tree-view of my project at hand. This is the best option out there
+ - Startify - Cool startup screen and session manager
+ - Vimwiki - Manage my markdown docs
+
+## NerdFonts
+Download from [AUR](https://aur.archlinux.org/packages/nerd-fonts-dejavu-complete/)
+
+## VimWiki
+`VimWiki` can be accessed by `<Leader>ww` from any `Vim` instance (requires `env` repo to be in `~/Documents/Projects/`).
+
+To toggle conceal level (to comfortably edit links) use `<Leader>c`.
+
+## Vifm
+
+### Inactive pane displays ugly
+Remove line containing `OtherWin` in [`$VIFM/colors/Default.vifm`](vfile:~/.config/vifm/colors/Default.vifm)
+
+### Remove borders
+Replace all occurences of `ctermbg=white` with `ctermbg=black` in [the same file](vfile:~/.config/vifm/colors/Default.vifm).
+
+### Icons
+Support icons - extend [`vifmrc`](vfile:~/.config/vifm/vifmrc):
+```
+" file types
+set classify=' :dir:/, :exe:, :reg:, :link:'
+" various file names
+set classify+=' ::../::, ::*.sh::, ::/^copying|license$/::, ::.git/,,*.git/::, ::*.epub,,*.fb2,,*.djvu::, ::*.pdf::, ::*.htm,,*.html,,**.[sx]html,,*.xml::'
+" archives
+set classify+=' ::*.7z,,*.ace,,*.arj,,*.bz2,,*.cpio,,*.deb,,*.dz,,*.gz,,*.jar,,*.lzh,,*.lzma,,*.rar,,*.rpm,,*.rz,,*.tar,,*.taz,,*.tb2,,*.tbz,,*.tbz2,,*.tgz,,*.tlz,,*.trz,,*.txz,,*.tz,,*.tz2,,*.xz,,*.z,,*.zip,,*.zoo::'
+" images
+set classify+=' ::*.bmp,,*.gif,,*.jpeg,,*.jpg,,*.ico,,*.png,,*.ppm,,*.svg,,*.svgz,,*.tga,,*.tif,,*.tiff,,*.xbm,,*.xcf,,*.xpm,,*.xspf,,*.xwd::'
+" audio
+set classify+=' ::*.aac,,*.anx,,*.asf,,*.au,,*.axa,,*.flac,,*.m2a,,*.m4a,,*.mid,,*.midi,,*.mp3,,*.mpc,,*.oga,,*.ogg,,*.ogx,,*.ra,,*.ram,,*.rm,,*.spx,,*.wav,,*.wma,,*.ac3::'
+" media
+set classify+=' ::*.avi,,*.axv,,*.divx,,*.m2v,,*.m4p,,*.m4v,,.mka,,*.mkv,,*.mov,,*.mp4,,*.flv,,*.mp4v,,*.mpeg,,*.mpg,,*.nuv,,*.ogv,,*.pbm,,*.pgm,,*.qt,,*.vob,,*.wmv,,*.xvid::'
+" office files
+set classify+=' ::*.doc,,*.docx::, ::*.xls,,*.xls[mx]::, ::*.pptx,,*.ppt::'
+" development
+set classify+=' ::*.js,,*.jsx::, ::*.ts,,*.tsx::, ::*.md::, ::*.json::, ::*.c,,*.cc,,*.h,,*.cpp::, ::*.vim::'
+```
+
+
+### Open dir as i3 workspace
+To use [workspace generator script](xorg.md) in `vifm`, add this line to [`vifmrc`](vfile:~/.config/vifm/vifmrc), preferably where all `!command` lines are (around line ~140):
+```
+command! w :!i3-workspace.sh %d/%c
+```
+
diff --git a/wiki/dotfiles/xorg.md b/wiki/dotfiles/xorg.md
new file mode 100644
index 0000000..c44789b
--- /dev/null
+++ b/wiki/dotfiles/xorg.md
@@ -0,0 +1,17 @@
+# Xorg
+
+## i3wm
+
+### Workspace generator
+Script `/bin/i3-workspace.sh` provides an easy-to-use layout generator:
+```bash
+./i3-workspace.sh ~/path/to/my/working/directory
+```
+It will open `nvim` + `alacritty` in a new workspace. It is prefered to move it to bin and alias to some command in [vifm](vim.md).
+
+### Bassboost mode
+While key combination `win+b` is pressed, **crazy bassboost mic mode** is active. Basically it's just the toggle between two mic volumes - default and very high (up to the point when it starts distorting).
+This is just for fun and probably should not be here, but I decided to leave it anyway.
+
+**Note**: using this is dangerous since it might hurt someone's ears or damage the microphone.
+