commit 18cad604ddbd325a76a3da0e952a5698e7f1b541 · ejri.dev/baredot.nvim

+75
doc/baredot.nvim.txt
···

       1
       1
       +
       *baredot.nvim.txt*        For Neovim >= 0.9.0        Last change: 2024 June 17

     

       2
       2
       +
       

     

       3
       3
       +
       ==============================================================================

     

       4
       4
       +
       Table of Contents                             *baredot.nvim-table-of-contents*

     

       5
       5
       +
       

     

       6
       6
       +
       1. Baredot                                              |baredot.nvim-baredot|

     

       7
       7
       +
         - Details                                     |baredot.nvim-baredot-details|

     

       8
       8
       +
         - Setup                                         |baredot.nvim-baredot-setup|

     

       9
       9
       +
         - Configuration                         |baredot.nvim-baredot-configuration|

     

       10
       10
       +
         - Commands                                   |baredot.nvim-baredot-commands|

     

       11
       11
       +
         - Functions                                 |baredot.nvim-baredot-functions|

     

       12
       12
       +
       

     

       13
       13
       +
       ==============================================================================

     

       14
       14
       +
       1. Baredot                                              *baredot.nvim-baredot*

     

       15
       15
       +
       

     

       16
       16
       +
       This is a Neovim plugin to automatically adjust `git` env vars when syncing

     

       17
       17
       +
       dotfiles using the "bare git repo" method:

     

       18
       18
       +
       

     

       19
       19
       +
       Dotfiles: Best way to store in a bare git repository

     

       20
       20
       +
       <https://www.atlassian.com/git/tutorials/dotfiles>

     

       21
       21
       +
       

     

       22
       22
       +
       

     

       23
       23
       +
       DETAILS                                         *baredot.nvim-baredot-details*

     

       24
       24
       +
       

     

       25
       25
       +
       When launching and when changing directory (eg. `:cd`), the plugin will detect

     

       26
       26
       +
       if the current directory is in a git repo by searching for a `.git` folder.

     

       27
       27
       +
       

     

       28
       28
       +
       - If a `.git` folder is found, the env vars are cleared and `git` will work as normal.

     

       29
       29
       +
       - If a `.git` folder is not found, and we are in `$HOME`, the env vars will be adjusted to use the

     

       30
       30
       +
           bare git repo. This will let other git plugins function using that repo.

     

       31
       31
       +
       

     

       32
       32
       +
       

     

       33
       33
       +
       SETUP                                             *baredot.nvim-baredot-setup*

     

       34
       34
       +
       

     

       35
       35
       +
       lazy.nvim

     

       36
       36
       +
       

     

       37
       37
       +
       >lua

     

       38
       38
       +
           {

     

       39
       39
       +
             "ejrichards/baredot.nvim",

     

       40
       40
       +
             opts = {

     

       41
       41
       +
               git_dir = "~/.cfg" -- Change this path

     

       42
       42
       +
             }

     

       43
       43
       +
           }

     

       44
       44
       +
       <

     

       45
       45
       +
       

     

       46
       46
       +
       

     

       47
       47
       +
       CONFIGURATION                             *baredot.nvim-baredot-configuration*

     

       48
       48
       +
       

     

       49
       49
       +
       >lua

     

       50
       50
       +
           {

     

       51
       51
       +
             -- These two options set the GIT_DIR and GIT_WORK_TREE env vars

     

       52
       52
       +
             -- They are expanded using "vim.fn.expand"

     

       53
       53
       +
             git_dir = "~/.cfg",

     

       54
       54
       +
             git_work_tree = "~",

     

       55
       55
       +
             -- Filename pattern to find that will disable Baredot

     

       56
       56
       +
             disable_pattern = "%.git"

     

       57
       57
       +
           }

     

       58
       58
       +
       <

     

       59
       59
       +
       

     

       60
       60
       +
       

     

       61
       61
       +
       COMMANDS                                       *baredot.nvim-baredot-commands*

     

       62
       62
       +
       

     

       63
       63
       +
       - `:BaredotInfo` - Print current status

     

       64
       64
       +
       - `:BaredotToggle` - Manually toggle the env vars on / off

     

       65
       65
       +
       

     

       66
       66
       +
       

     

       67
       67
       +
       FUNCTIONS                                     *baredot.nvim-baredot-functions*

     

       68
       68
       +
       

     

       69
       69
       +
       - `require("baredot").info()` - Print current status

     

       70
       70
       +
       - `require("baredot").toggle()` - Manually toggle the env vars on / off

     

       71
       71
       +
       - `require("baredot").set(boolean)` - Set the env vars on / off

     

       72
       72
       +
       

     

       73
       73
       +
       Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

     

       74
       74
       +
       

     

       75
       75
       +
       vim:tw=78:ts=8:noet:ft=help:norl: