From 169889298179cbf17c69e11894236a991a7b7cda Mon Sep 17 00:00:00 2001 From: Mist Date: Wed, 3 Apr 2024 17:14:53 +0800 Subject: [PATCH] [Update] add contributors chapter & update the usage --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 5c79055..b2a5241 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 MIT.