{"id":13682241,"url":"https://github.com/Djancyp/cheat-sheet","last_synced_at":"2025-04-30T07:30:59.692Z","repository":{"id":38076157,"uuid":"501217692","full_name":"Djancyp/cheat-sheet","owner":"Djancyp","description":"Nvim cheat sheet implementation","archived":false,"fork":false,"pushed_at":"2022-08-03T16:35:19.000Z","size":293,"stargazers_count":55,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-02T13:33:52.331Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Djancyp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-08T11:16:16.000Z","updated_at":"2024-03-19T13:30:47.000Z","dependencies_parsed_at":"2022-08-08T23:00:40.075Z","dependency_job_id":null,"html_url":"https://github.com/Djancyp/cheat-sheet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Djancyp%2Fcheat-sheet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Djancyp%2Fcheat-sheet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Djancyp%2Fcheat-sheet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Djancyp%2Fcheat-sheet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Djancyp","download_url":"https://codeload.github.com/Djancyp/cheat-sheet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224201915,"owners_count":17272664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T13:01:42.712Z","updated_at":"2024-11-12T01:31:23.897Z","avatar_url":"https://github.com/Djancyp.png","language":"Lua","funding_links":[],"categories":["Lua"],"sub_categories":[],"readme":"# Nvim Cheat Sheet\n\nThis plugin allows you to use cheat sheet ([cht.sh](https://cht.sh/)) inside the vim.\n\n- Plugin written 100 % in lua.\n  ![](https://github.com/Djancyp/cheat-sheet/blob/main/images/cheat-sheet.gif)\n\n## Installation\n\nPacker\n\n```bash\nuse {\"Djancyp/cheat-sheet\"}\n```\n\n## Config\n\nOptionally, you can also pass some configuration to the plugin, here's the default value:\n\n```lua\nrequire(\"cheat-sheet\").setup({\n  auto_fill = {\n    filetype = true,\n    current_word = true,\n  },\n\n  main_win = {\n    style = \"minimal\",\n    border = \"double\",\n  },\n\n  input_win = {\n    style = \"minimal\",\n    border = \"double\",\n  },\n})\n```\n\n- `auto_fill`:\n\n  - `filetype`: automatically add filetype prefix to search query (ex: `lua/`)\n  - `current_word`: automatically add the current word under your cursor to search query\n\n- `main_win`:\n\n  - `style`: main window style (see: `:h nvim_open_win()`)\n  - `border`: main window border (see: `:h nvim_open_win()`)\n\n- `input_win`:\n\n  - `style`: input window style (see: `:h nvim_open_win()`)\n  - `border`: input window border (see: `:h nvim_open_win()`)\n\n## Usage\n\n```bash\n:CheatSH\n```\n\nThis 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.\n\n### Ex:\n\n```\nlua/for\n```\n\n```\ngit/pull\n```\n\n```\njs/async\n```\n\nFor more information please visit the cheat sheet website - ([cht.sh](https://cht.sh/))\n\n## Keys\n\n```\n| Key            | Action                          |\n| -------------- | ------------------------------- |\n| q              | exit cheat sheet window         |\n| \u003cC-c\u003e          | exit input window (input mode)  |\n| \u003cC-d\u003e          | remove text (input mode)        |\n| `\u003cCR\u003e`(Enter)  | activate the search             |\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDjancyp%2Fcheat-sheet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDjancyp%2Fcheat-sheet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDjancyp%2Fcheat-sheet/lists"}