Linux, Mac	Windows
~/.vim	~/vimfiles

in the terminal:

cd ~/.vim && git clone --depth=1 https://github.com/azabiong/vim-board.git pack/azabiong/start/vim-board
cd ~/.vim && vim -u NONE -c "helptags pack/azabiong/start/vim-board/doc" -c q

    let BoardPath = '~/.config/boards'

    nmap '<Space> <Plug>(BoardMenu)

    vim.g.BoardPath = '~/.config/boards'

    vim.keymap.set('n', "'<Space>", '<Plug>(BoardMenu)')

A key can consist of any combination of symbols, alphanumeric, and Unicode characters except those that start with some predefined characters.

Available leading characters:

    ~!@$%^&*_()[]{}'`";,.\/? 0-9 a-z A-Z and Unicode characters

Used in the menu and syntax:

    -  previous     #  comment 
    =  main         |  command 
    +  new
    <  load
    >  unload
    :  command

The same key can be defined differently on each board.

Long keys

Long keys can be activated by typing only the unique prefix portion of the key.   For example, if you define a link with a long key xylophone, and no other keys start with xy, you can open the link with xy Enter.

To easily define a link to a file, the plugin supports copying the current file's path to a register when the menu key is pressed (by default the b register).

To paste the path stored in register b in insert mode:

      Ctrl+R b

🍏  Tip

When switching to another board stored in the BoardPath directory, you can omit the path and specify only the file name.  For example:

      'a  another.board

Switching boards using the defined keys will automatically load the links defined on the board.

Additional commands can be added using the | bar character.

For example, to browse files after changing the current working directory:

      \py  ~/Languages/Python/ | edit .

After opening the file, to go to the line 128:

       pn  ~/Languages/Python/notes.py | 128

More commands can be combined together:

      \d1 ~/Directory/ | NERDTreeCWD | wincmd p | edit README.md

Commands only

You can also define just a list of commands without specifying a file or directory.

For example, to define a command that copies frequently used commands or strings to the clipboard:

      s1  | let @+ = "copy this string to the clipboard"

To define a substitution command:

      ss  | %s/Foo/Bar/gc

To define a set of temporary key-maps:

      key | nn f0 <Cmd>echo 0<CR>
          | nn f9 <Cmd>echo 9<CR>

To define some input from the shell tool to the scratchpad, Board*:

      sh1 | Board* | r! echo "This is the scratchpad on the Board"
      sh2 | Board* | r! curl -sI example.com

Multi-line commands

Multi-line commands  can be set using the leading bar | character.

      c1  ~/directory/or_file
          | echo 'foo'
          | echo 'bar'

Link reference

You can refer to links using the '&' symbol instead of duplicates. For example:

      \d1 ~/directory1/ | &_N
      \d2 ~/directory2/ | &_N

      _N  | NERDTreeCWD | wincmd =

Command-line mode

When using the | bar character as a shell pipe or other meaning, you can switch to command-line mode input by adding a colon : after the bar.

      sh3 | Board* |: r! ls | wc
      sh4 | Board* |: r! cat ~/.ssh/known_hosts | awk '$1 ~ /[0-9]/ { print $1; exit }'

Stop command

To stop a long list of commands while processing, press the menu key and input Ctrl+C or an undefined key.