https://github.com/ernstwi/vim-secret

Private writing mode for Vim
https://github.com/ernstwi/vim-secret

vim

Last synced: 2 months ago
JSON representation

Private writing mode for Vim

• Host: GitHub
• URL: https://github.com/ernstwi/vim-secret
• Owner: ernstwi
• License: mit
• Created: 2021-01-28T21:48:17.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-20T12:10:19.000Z (about 3 years ago)
• Last Synced: 2024-08-01T16:56:17.118Z (5 months ago)
• Topics: vim
• Language: Vim script
• Homepage:
• Size: 19.5 KB
• Stars: 63
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vim-secret



    



## Usage

    

        :Secret

        Enable secret view.

    

        :Secret (line | word | char | none)

        Enable secret view with a specific visibility setting.

    

        :Secret!

        Disable secret view.

    

    

        <Plug>SecretToggle

        Toggle secret view.

    

An area around the cursor is unhidden to enable you to see what you are typing. This can be the entire line, the current word, the current character, or it can be disabled completely.

After a duration of time without input, or invoked manually via a mapping, all characters in the buffer is hidden. For details on this and other configuration options, see [`:help secret`](./doc/secret.txt).

## FAQ

> Replacement characters have a background color, which looks weird.

This is due to how your color scheme styles the `Conceal` highlight group. To remove the background color, you could use something like the following in your `vimrc`/`init.vim`:

```vim

autocmd! VimEnter,ColorScheme * hi Conceal ctermbg=NONE guibg=NONE

```

See [`:help secret-highlight`](./doc/secret.txt#L74) for more info.

## Testing

Docker can be used to run tests in an isolated environment:

```

$ docker build -t vim-secret .

$ docker run --rm vim-secret [--verbose]

```