mirror
/
codesnap.nvim
mirror of https://github.com/mistricky/codesnap.nvim
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

[Update] add contributors chapter & update the usage

pull/62/head
Mist 2024-04-03 17:14:53 +08:00 committed by GitHub
parent 8e7d77ea41
commit 1698892981
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -114,6 +114,15 @@ require("codesnap").setup({
}) })
``` ```
### Specify language extension
In some scenarios, CodeSnap.nvim cannot auto-detect what language syntax should used to highlight code, for example, shell script can have no extension, they specify interpreters using shebang.
CodeSnap.nvim won't read the whole content of the file, thus cannot detect what language syntax is this, in this case, you can specify extension explicitly, for instance:
```shell
CodeSnapSave sh
CodeSnap sh
```
https://github.com/mistricky/codesnap.nvim/assets/22574136/69b27e77-3dce-4bc3-8516-89ce636fe02d https://github.com/mistricky/codesnap.nvim/assets/22574136/69b27e77-3dce-4bc3-8516-89ce636fe02d
@ -241,5 +250,10 @@ There is a default config:
} }
``` ```
## Contribution
CodeSnap.nvim is a project that will be maintained for the long term, and we always accepts new contributors, please feel free to submit PR & issues.
The commit message convention of this project is following [commitlint-wizardoc](https://github.com/wizardoc/commitlint-wizardoc).
## License ## License
MIT. MIT.