README.MD

figban.nvim

This neovim plugin will help you easily create commented figlet banners to separate your code and configurations.

Requirement

This plugin requires figlet to be installed.

RedHat like

dnf install figlet

Debian like

apt install figlet

Arch

pacman -S figlet

Installation

Vim Plug

Vim-Plug

1. Add Plug 'thazelart/figban.nvim' to your vimrc file.
2. Reload your vimrc or restart
3. Run :PlugInstall

Dein.vim

Dein.vim

1. Add call dein#add('thazelart/figban.nvim') to your vimrc file.
2. Reload your vimrc or restart
3. Run :call dein#install()

Vundle

Vundle or similar

1. Add Plugin 'thazelart/figban.nvim' to your vimrc file.
2. Reload your vimrc or restart
3. Run :BundleInstall

Configuration

You can choose you figlet fontstyle by adding this config in your vimrc

let g:figban_fontstyle='shadow'

command

Generate your banner

:Figban My banner

Examples

Golang

/**  __  __         ____
 *  |  \/  |_   _  | __ )  __ _ _ __  _ __   ___ _ __
 *  | |\/| | | | | |  _ \ / _` | '_ \| '_ \ / _ \ '__|
 *  | |  | | |_| | | |_) | (_| | | | | | | |  __/ |
 *  |_|  |_|\__, | |____/ \__,_|_| |_|_| |_|\___|_|
 *          |___/
**/

Python

"""  __  __         ____
    |  \/  |_   _  | __ )  __ _ _ __  _ __   ___ _ __
    | |\/| | | | | |  _ \ / _` | '_ \| '_ \ / _ \ '__|
    | |  | | |_| | | |_) | (_| | | | | | | |  __/ |
    |_|  |_|\__, | |____/ \__,_|_| |_|_| |_|\___|_|
            |___/
"""

Bash

#  __  __         ____
# |  \/  |_   _  | __ )  __ _ _ __  _ __   ___ _ __
# | |\/| | | | | |  _ \ / _` | '_ \| '_ \ / _ \ '__|
# | |  | | |_| | | |_) | (_| | | | | | | |  __/ |
# |_|  |_|\__, | |____/ \__,_|_| |_|_| |_|\___|_|
#         |___/
#

Lua

--[[  __  __         ____
--   |  \/  |_   _  | __ )  __ _ _ __  _ __   ___ _ __
--   | |\/| | | | | |  _ \ / _` | '_ \| '_ \ / _ \ '__|
--   | |  | | |_| | | |_) | (_| | | | | | | |  __/ |
--   |_|  |_|\__, | |____/ \__,_|_| |_|_| |_|\___|_|
--           |___/
--]]