Git Product home page Git Product logo

cheat-sheet's Introduction

Nvim Cheat Sheet

This plugin allows you to use cheat sheet (cht.sh) inside the vim.

  • Plugin written 100 % in lua.

Installation

Packer

use {"Djancyp/cheat-sheet"}

Config

Optionally, you can also pass some configuration to the plugin, here's the default value:

require("cheat-sheet").setup({
  auto_fill = {
    filetype = true,
    current_word = true,
  },

  main_win = {
    style = "minimal",
    border = "double",
  },

  input_win = {
    style = "minimal",
    border = "double",
  },
})
  • auto_fill:

    • filetype: automatically add filetype prefix to search query (ex: lua/)
    • current_word: automatically add the current word under your cursor to search query
  • main_win:

    • style: main window style (see: :h nvim_open_win())
    • border: main window border (see: :h nvim_open_win())
  • input_win:

    • style: input window style (see: :h nvim_open_win())
    • border: input window border (see: :h nvim_open_win())

Usage

:CheatSH

This will open an input window and base on your filetype it will highlight the first part of search. When your query ready just hit the enter.

Ex:

lua/for
git/pull
js/async

For more information please visit the cheat sheet website - (cht.sh)

Keys

| Key            | Action                          |
| -------------- | ------------------------------- |
| q              | exit cheat sheet window         |
| <C-c>          | exit input window (input mode)  |
| <C-d>          | remove text (input mode)        |
| `<CR>`(Enter)  | activate the search             |

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

cheat-sheet's People

Contributors

djancyp avatar ibldzn avatar renanbrayner avatar whleucka avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.