Welcome to Vim-Mahewin-Repository’s documentation!

Contents:

Install

Explain how you can install the project.

Using curl

curl -L https://github.com/hobbestigrou/Vim-Mahewin-Repository/raw/master/install.sh | bash

Using wget

wget --no-check-certificate https://github.com/hobbestigrou/Vim-Mahewin-Repository/raw/master/install.sh -O - | bash

Manually

To install the project simply clone:

git clone https://github.com/hobbestigrou/Vim-Mahewin-Repository.git .vim-mahewin-repository

And then make a symbolic link:

ln -s .vim-mahewin-repository/vimrc .vimrc

I recommend using the method with curl or wget.

Alias

Aliases for common commands source of error.

Save and quit

:WQ
:Wq

All aliases to save and quit.

Save

:W

All aliases to save.

Quit

:Q

All aliases to quit.

Common

Some useful intersting features.

Ranger

A command to open ranger to navigate in the file system. Ranger is a file with Vim key bindings. It provides a minimalistic and nice curses interface with a view on the directory hierarchy. Ranger must be installed for this command to work. For Debian and derivatives:

You have you have two possibility. Call the command or use the mapping.

With the command:

:Ranger

With the mapping:

<leader>r

Not required if you do not want to use.

Get update

To get the latest version, you have two possibility. Call the command or use the mapping.

With the command:

:GetUpdateVimMahewinRepository

With the mapping:

<leader>u

It takes the master version of git repository.

Create Git Branch

A function to create a local branch, you have two possibility. Call the command or use the mapping.

:Create_git_branch

With the mapping:

<leader>gbc

It uses the option -b from checkout is therefore moves in the branch created. The command use stash to be sure the repository is clean before create the new branch. Can take two parameters the first one is the name of the branch to create the other one is the branch on must be based.

Remove All Git Branch

A function to remove all local branch if it’s merged on master. If the branch exist on the remote it was also delete in the remote. Call the command or use the mapping.

:RemoveAllGitBranch

With the mappingL

<leader>gbd

If the branch exist on the remote it was also delete in the remote.

Plugins

Vim-Mahewin-Repository comes with plugins and are configured to most. Each configuration options can be overridden in the configuration file vimrc.local.

Syntastic

Syntastic is a awesome plugin to check syntax displays any resulting errors.

Symbol style

When errors or warnings a symbol is displayed on the side of the line. Vim-Mahewin-Repository provides custom style for syntastic_error_symbol ✗, for syntastic_style_error_symbol S✗, for syntastic_warning_symbol ⚠, and for syntastic_style_warning_symbol S⚠.

Active file

Currently Vim-Mahewin-Repository check the syntax automatically at the opening and closing and saving files for Perl, Python, and C language.

Passive file

To check syntax of PHP file you need explicitly call SyntasticCheck command.

Information

To see information about the current file you can call SyntasticInfo command.

Vundle

Vundle is a Vim plugin manager.

Update

To update plugins it’s possible to use :BundleInstall! or keymap <leader>vu.

Tagbar

Tagbar is a Vim plugin for browsing the tags of source code files. It provides a sidebar that displays the ctags, need install exuberant-ctags, use F9 to toggle the tagbar window.

NERDTree

The NERD tree allows you to explore your filesystem and to open files and directories. Use F11 to display the tree and q to quit the tree.

Fortune vimtips

Fortune vimtips is a project inspired by fortune software to display vimtips. Open a new horizontal split buffer to display the vimtips.

Display in a new window

By default it’s display in a message, but it’s be possible to display in a new buffer:

let g:fortune_vimtips_display_in_window = 0

Be display in a new vertical split.

Disable auto display

Activate by default it’s obvious to disable auto display, to deactivate the auto display add this line on your .vimrc.local:

let g:fortune_vimtips_auto_display = 0

Then it’s possible to display vimtips with the command:

:Fortune

When you want learn few new things about vim.

Custom plugin

Install

To install plugins that are not provided by Vim-Mahewin-Repository it is possible to create a file call .bundle.local in the user directory:

Bundle 'benmills/vimux'

After adding the line, it must run the command :BundleInstall that all. But if you find an interesting plugin do enjoy the community and made a pull request.

Uninstall

To uninstall a custom plugin, remove the line of the file and run the command :BundleClean to remove the plugin of .vim directory.

Indices and tables

Introduction

Vim-Mahewin-Repository is a Vim distribution like janus or bling, or prezto for zsh.

What does that mean

It’s my personal vim distribution that I have tweaked over time and evolved from a simple vanilla vimrc configuration to a full-blown distribution that it is today.

That included few good plugin, map, alias and so on.