*snapper.txt*         Plugin for semantic line break formatting

SNAPPER.VIM

CONTENTS                                        *snapper-contents*

Introduction                    |snapper-intro|
Installation                    |snapper-install|
Usage                         |snapper-usage|
Commands                      |snapper-commands|
Integration                   |snapper-integration|
License                       |snapper-license|

==============================================================================
INTRODUCTION                                    *snapper-intro*

snapper.vim provides integration with snapper, a semantic line break formatter
for prose documents. It supports Org mode, LaTeX, Markdown, reStructuredText,
and plain text files.

Features:
- Format with snapper via command execution
- Vim compatibility via formatprg
- Auto-detection of filetypes for appropriate formatting

Requirements:
- Vim 8.0+ (with +job feature preferred)
- snapper binary installed

==============================================================================
INSTALLATION                                  *snapper-install*

vim-plug:
>
  Plug 'TurtleTech-ehf/snapper', { 'rtp': 'editors/vim' }
<

Vim packages (built-in):
>
  git clone https://github.com/TurtleTech-ehf/snapper.git ~/.vim/pack/plugins/start/snapper
  # Then modify the path to point to editors/vim
<

==============================================================================
USAGE                                         *snapper-usage*

After installation, snapper will automatically set formatprg for supported
filetypes. You can use the provided commands to format manually.

==============================================================================
COMMANDS                                      *snapper-commands*

:SnapperFormat                                 *:SnapperFormat*
    Format the current buffer using snapper.

:SnapperCheck                                  *:SnapperCheck*
    Check if formatting is needed.

:SnapperRestart                                *:SnapperRestart*
    Restart functionality (not applicable in Vim).

:SnapperInfo                                   *:SnapperInfo*
    Show plugin status information.

==============================================================================
INTEGRATION                                  *snapper-integration*

The plugin automatically sets formatprg for supported filetypes:
- org: snapper --format org
- tex: snapper --format latex
- markdown: snapper --format markdown
- rst: snapper --format rst
- plaintex: snapper --format plaintex

This enables formatting with gq operator in normal mode.

==============================================================================
LICENSE                                       *snapper-license*

MIT License

Copyright (c) 2025 TurtleTech

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

vim:tw=78:ts=8:ft=help:norl: