How to use this config

Edit simple file

You can just use command nvim /path/to/file to edit the file.


See customize to learn how to setup the LSP. Then go into your project directory and use command nvim /path/to/source code to open and edit the code.

Write Markdown

Use command nvim /path/to/ to open the markdown file. And their are some commands can enhance your writing experience:

  • :TableModeToggle: Trigger the table edit mode.
  • :MarkdownPreview: Preview the rendered markdown content in your favourite browser. See customize for details.
  • :GenTocGFM: Generate a GitHub favor TOC.


Each folder under lua/ directory has a file to indicate what it is and what plugin it has. You can learn more from there.