First release

doc/neovim/0 - Prerequisities.md

@@ -0,0 +1,9 @@
+
+| Environment variable | Path |
+| :- | :- |
+|XDG_CONFIG_HOME| z:\\home\\.config|
+|XDG_DATA_HOME|z:\\home\\.data|
+
+### Folder structure
+
+~/.config/nvim

doc/neovim/2 - Font, icons, color-schema and status-line.md

@@ -0,0 +1,105 @@
+## 2.1 - Font
+
+The font we use in neovim is one from the [nerd]() font collection. Those fonts contain special characters used as an icon in NeoVim. "SauceCodePro NF" is a derivation of the "SourceCodePro" font.
+
+`lua/roka/core/options.lua`
+```lua
+vim.opt.guifont = { "SauceCodePro NF:h11:#e-subpixelantialias:#h-none" }
+```
+
+## 2.2 - Icons
+
+The various icons can be used by many plugins, example _nvim-tree_ or _lualine_.
+
+`lua/roka/core/plugins.lua`
+```lua
+return require('packer').startup(function()
+    -- other plugins...
+    
+	use "kyazdani42/nvim-web-devicons"
+    
+    -- other plugins...
+end)
+```
+
+## 2.3 - Color-scheme
+
+`lua/roka/core/plugins.lua`
+```lua
+return require('packer').startup(function()
+    -- other plugins...
+    
+	use { "bluz71/vim-nightfly-colors", as = "nighfly" }
+	use { "bluz71/vim-moonfly-colors",  as = "moonfly" }
+    
+    -- other plugins...
+end)
+```
+`lua/roka/plug/color.lua`
+
+`init.lua`
+```lua
+    -- other requires
+    
+    require( "roka.plug.color")
+    
+    -- other requires
+```
+
+## 2.4 - LuaLine
+
+`lua/roka/core/plugins.lua`
+```lua
+return require('packer').startup(function()
+    -- other plugins...
+    
+	use "nvim-lualine/lualine.nvim"
+    
+    -- other plugins...
+end)
+```
+
+`lua/roka/plug/lualine.lua`
+```lua
+local status, lualine = pcall( require, "lualine")
+if not status then
+  return
+end
+
+local lualine_nightfly = require("lualine.themes.nightfly")
+
+local new_colors = {
+  blue    = "#65D1FF",
+  green   = "#3EFFDC",
+  violet  = "#FF61EF",
+  yellow  = "#FFDA7B",
+  black   = "#000000",
+}
+
+lualine_nightfly.normal.a.bg  = new_colors.blue
+lualine_nightfly.insert.a.bg  = new_colors.green
+lualine_nightfly.visual.a.bg  = new_colors.violet
+
+lualine_nightfly.command = {
+  a = {
+    gui = "bold",
+    bg  = new_colors.yellow,
+    fg  = new_colors.black,
+  },
+}
+
+lualine.setup({
+  options = {
+    theme = lualine_nightfly
+  }
+})
+```
+
+`init.lua`
+```lua
+    -- other requires
+    
+    require( "roka.plug.lualine")
+    
+    -- other requires
+```

doc/neovim/3 - Telescope.md

@@ -0,0 +1,136 @@
+`lua/roka/core/plugins.lua`
+```lua
+return require('packer').startup(function()
+    -- other plugins...
+    
+	use "nvim-telescope/telescope.nvim"
+    
+    -- other plugins...
+end)
+```
+`lua/roka/plug/telescope.lua`
+```lua
+local status_ok, telescope = pcall(require, "telescope")
+if not status_ok then
+  return
+end
+
+telescope.load_extension('media_files')
+
+local actions = require "telescope.actions"
+
+telescope.setup {
+  defaults = {
+
+    prompt_prefix = " ",
+    selection_caret = " ",
+    path_display = { "smart" },
+
+    -- The minimal init not showing preview by default is likely due to the default 
+    -- preview_cutoff value of 120 columns. It looks like your terminal is smaller than 120 columns.
+    -- Set cutoff to zero to show the preview anyway
+    layout_config = {
+      horizontal = {
+        preview_cutoff = 0,
+      },
+    },
+
+    mappings = {
+      i = {
+		["<C-n>" ] = actions.cycle_history_next,
+        ["<C-p>" ] = actions.cycle_history_prev,
+
+        ["<C-j>" ] = actions.move_selection_next,
+        ["<C-k>" ] = actions.move_selection_previous,
+
+        ["<C-c>" ] = actions.close,
+
+        ["<Down>"] = actions.move_selection_next,
+        ["<Up>"  ] = actions.move_selection_previous,
+
+        ["<CR>"  ] = actions.select_default,
+        ["<C-x>" ] = actions.select_horizontal,
+        ["<C-v>" ] = actions.select_vertical,
+        ["<C-t>" ] = actions.select_tab,
+
+        ["<C-u>" ] = actions.preview_scrolling_up,
+        ["<C-d>" ] = actions.preview_scrolling_down,
+
+        ["<PageUp>"] = actions.results_scrolling_up,
+        ["<PageDown>"] = actions.results_scrolling_down,
+
+        ["<Tab>"] = actions.toggle_selection + actions.move_selection_worse,
+        ["<S-Tab>"] = actions.toggle_selection + actions.move_selection_better,
+        ["<C-q>"] = actions.send_to_qflist + actions.open_qflist,
+        ["<M-q>"] = actions.send_selected_to_qflist + actions.open_qflist,
+        ["<C-l>"] = actions.complete_tag,
+        ["<C-_>"] = actions.which_key, -- keys from pressing <C-/>
+      },
+
+      n = {
+        ["<esc>"  ] = actions.close,
+        ["<CR>"   ] = actions.select_default,
+        ["<C-x>"  ] = actions.select_horizontal,
+        ["<C-v>"  ] = actions.select_vertical,
+        ["<C-t>"  ] = actions.select_tab,
+
+        ["<Tab>"  ] = actions.toggle_selection + actions.move_selection_worse,
+        ["<S-Tab>"] = actions.toggle_selection + actions.move_selection_better,
+        ["<C-q>"  ] = actions.send_to_qflist + actions.open_qflist,
+        ["<M-q>"  ] = actions.send_selected_to_qflist + actions.open_qflist,
+
+        ["j"] = actions.move_selection_next,
+        ["k"] = actions.move_selection_previous,
+        ["H"] = actions.move_to_top,
+        ["M"] = actions.move_to_middle,
+        ["L"] = actions.move_to_bottom,
+
+        ["<Down>"] = actions.move_selection_next,
+        ["<Up>"] = actions.move_selection_previous,
+        ["gg"] = actions.move_to_top,
+        ["G"] = actions.move_to_bottom,
+
+        ["<C-u>"] = actions.preview_scrolling_up,
+        ["<C-d>"] = actions.preview_scrolling_down,
+
+        ["<PageUp>"] = actions.results_scrolling_up,
+        ["<PageDown>"] = actions.results_scrolling_down,
+
+        ["?"] = actions.which_key,
+      },
+    },
+  },
+  -- pickers = {
+    -- Default configuration for builtin pickers goes here:
+    -- picker_name = {
+    --   picker_config_key = value,
+    --   ...
+    -- }
+    -- Now the picker_config_key will be applied every time you call this
+    -- builtin picker
+  -- },
+  extensions = {
+    media_files = {
+        -- filetypes whitelist
+        -- defaults to {"png", "jpg", "mp4", "webm", "pdf"}
+        filetypes = {"png", "webp", "jpg", "jpeg"},
+        find_cmd = "rg" -- find command (defaults to `fd`)
+      }
+    -- Your extension configuration goes here:
+    -- extension_name = {
+    --   extension_config_key = value,
+    -- }
+    -- please take a look at the readme of the extension you want to configure
+  },
+}
+```
+
+`init.lua`
+```lua
+  -- other requires
+
+  require( "roka.plug.telescope")
+
+  -- other requires
+```
+