Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jayli committed Dec 4, 2023
1 parent af07001 commit fba09f6
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 54 deletions.
55 changes: 1 addition & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,61 +264,8 @@ If you just want to use default nerdfonts configuration, you can simplily config
let g:easycomplete_nerd_font = 1
```

In most cases, the configuration "`g:easycomplete_nerd_font = 1`" is already enough, but if you want to customize the kind icon, you can modify the configuration like this with <https://nerdfonts.com> installed:
In most cases, the configuration "`g:easycomplete_nerd_font = 1`" is already enough, but if you want to customize the kind icon, you can modify the configuration like this with <https://nerdfonts.com> installed. [Some examples](beautify-menu-items.md).

```vim
let g:easycomplete_menu_skin = {
\ "buf": {
\ "kind":"⚯",
\ "menu":"[B]",
\ },
\ "snip": {
\ "kind":"<>",
\ "menu":"[S]",
\ },
\ "dict": {
\ "kind":"d",
\ "menu":"[D]",
\ },
\ "tabnine": {
\ "kind":"",
\ },
\ }
let g:easycomplete_lsp_type_font = {
\ 'text' : '⚯', 'method':'m', 'function': 'f',
\ 'constructor' : '≡', 'field': 'f', 'default':'d',
\ 'variable' : '𝘤', 'class':'c', 'interface': 'i',
\ 'module' : 'm', 'property': 'p', 'unit':'u',
\ 'value' : '𝘧', 'enum': 'e', 'keyword': 'k',
\ 'snippet': '𝘧', 'color': 'c', 'file':'f',
\ 'reference': 'r', 'folder': 'f', 'enummember': 'e',
\ 'constant':'c', 'struct': 's', 'event':'e',
\ 'typeparameter': 't', 'var': 'v', 'const': 'c',
\ 'operator':'o',
\ 't':'𝘵', 'f':'𝘧', 'c':'𝘤', 'm':'𝘮', 'u':'𝘶', 'e':'𝘦',
\ 's':'𝘴', 'v':'𝘷', 'i':'𝘪', 'p':'𝘱', 'k':'𝘬', 'r':'𝘳',
\ 'o':"𝘰", 'l':"𝘭", 'a':"𝘢", 'd':'𝘥',
\ }
```

Config error sign text:

```vim
let g:easycomplete_sign_text = {
\ 'error': "◉",
\ 'warning': "▲",
\ 'information': '◎',
\ 'hint': '▧'
\ }
```

You can define icon alias via giving fullnames and shortname.

Enable colorful styled menu (experimental):

```
let g:easycomplete_colorful = 1
```

### Add custom completion plugin

Expand Down
56 changes: 56 additions & 0 deletions beautify-menu-items.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

### Custom the complete menu

```vim
let g:easycomplete_menu_skin = {
\ "buf": {
\ "kind":"⚯",
\ "menu":"[B]",
\ },
\ "snip": {
\ "kind":"<>",
\ "menu":"[S]",
\ },
\ "dict": {
\ "kind":"d",
\ "menu":"[D]",
\ },
\ "tabnine": {
\ "kind":"",
\ },
\ }
let g:easycomplete_lsp_type_font = {
\ 'text' : '⚯', 'method':'m', 'function': 'f',
\ 'constructor' : '≡', 'field': 'f', 'default':'d',
\ 'variable' : '𝘤', 'class':'c', 'interface': 'i',
\ 'module' : 'm', 'property': 'p', 'unit':'u',
\ 'value' : '𝘧', 'enum': 'e', 'keyword': 'k',
\ 'snippet': '𝘧', 'color': 'c', 'file':'f',
\ 'reference': 'r', 'folder': 'f', 'enummember': 'e',
\ 'constant':'c', 'struct': 's', 'event':'e',
\ 'typeparameter': 't', 'var': 'v', 'const': 'c',
\ 'operator':'o',
\ 't':'𝘵', 'f':'𝘧', 'c':'𝘤', 'm':'𝘮', 'u':'𝘶', 'e':'𝘦',
\ 's':'𝘴', 'v':'𝘷', 'i':'𝘪', 'p':'𝘱', 'k':'𝘬', 'r':'𝘳',
\ 'o':"𝘰", 'l':"𝘭", 'a':"𝘢", 'd':'𝘥',
\ }
```

Config error sign text:

```vim
let g:easycomplete_sign_text = {
\ 'error': "◉",
\ 'warning': "▲",
\ 'information': '◎',
\ 'hint': '▧'
\ }
```

You can define icon alias via giving fullnames and shortname.

Enable colorful styled menu (experimental):

```
let g:easycomplete_colorful = 1
```

0 comments on commit fba09f6

Please sign in to comment.