Bullets.vim 使用教程

Bullets.vim 使用教程

bullets.vim 🔫 Bullets.vim is a Vim/NeoVim plugin for automated bullet lists. 项目地址: https://gitcode.com/gh_mirrors/bu/bullets.vim

1. 项目介绍

Bullets.vim 是一个 Vim/NeoVim 插件，用于自动化管理项目符号列表。它支持多种类型的列表，包括简单项目符号、缩进项目符号、有序列表和复选框列表等。通过使用 Bullets.vim，您可以快速创建和修改列表，提高文本编辑效率。

2. 项目快速启动

安装

• 使用 Vim 8.1+ 内置包管理器： 将插件克隆到 .vim/pack/plugins/start 目录下。确保您的 vimrc 文件中包含 packloadall。

• 使用 VimPlug： 在您的 vimrc 文件中添加以下插件声明：

  Plug 'bullets-vim/bullets.vim'
  

  然后执行 :PlugInstall 命令。

配置

您可以通过修改 g: 前缀的变量来自定义 Bullets.vim 的行为。以下是一些常见的配置选项：

let g:bullets_enabled_file_types = ['markdown', 'text', 'gitcommit', 'scratch']
let g:bullets_set_mappings = 1
let g:bullets_mapping_leader = '<M-b>'
let g:bullets_custom_mappings = [
    ['imap', '<cr>', '<Plug>(bullets-newline)'],
    ['nmap', 'o', '<Plug>(bullets-newline)'],
    ['vmap', 'gN', '<Plug>(bullets-renumber)'],
    ['nmap', '<leader>x', '<Plug>(bullets-toggle-checkbox)'],
    ['imap', '<C-t>', '<Plug>(bullets-demote)'],
    ['nmap', '>>', '<Plug>(bullets-demote)'],
    ['vmap', '>', '<Plug>(bullets-demote)'],
    ['imap', '<C-d>', '<Plug>(bullets-promote)'],
    ['nmap', '<<', '<Plug>(bullets-promote)'],
    ['vmap', '<', '<Plug>(bullets-promote)'],
]

使用

在 Markdown 或文本文件中，使用 - 或 * 开始一个项目符号列表。按回车键进入下一行，插件将自动创建一个新的列表项。

3. 应用案例和最佳实践

创建复选框列表

在列表项前添加 - [ ] 来创建一个复选框列表。使用 <leader>x 快捷键来切换复选框的状态。

- [ ] 任务一
- [ ] 任务二
- [ ] 任务三

自动重新编号

当您更改列表项的缩进级别或插入新的列表项时，Bullets.vim 可以自动重新编号有序列表。

let g:bullets_renumber_on_change = 1

使用嵌套列表

Bullets.vim 支持嵌套列表，使得创建层级结构变得简单。

1. 第一级
   - [ ] 第二级
       - [ ] 第三级

4. 典型生态项目

Bullets.vim 作为 Vim 插件生态系统的一部分，与许多其他插件协同工作，例如：

• VimPlug：用于管理 Vim 插件的插件。
• NeoVim：一个 Vim 的升级版，完全兼容 Vim 但提供更多现代特性。
• vim-markdown：一个支持 Markdown 语法的高亮和折叠的 Vim 插件。

通过整合这些项目，您可以打造一个功能强大的文本编辑环境。

bullets.vim 🔫 Bullets.vim is a Vim/NeoVim plugin for automated bullet lists. 项目地址: https://gitcode.com/gh_mirrors/bu/bullets.vim