@yaegassy/coc-marksman 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +60 -0
  3. package/lib/index.js +3359 -0
  4. package/package.json +121 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 yaegassy
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # coc-marksman
2
+
3
+ > fork from a [marksman-vscode](https://github.com/artempyanykh/marksman-vscode)
4
+
5
+ Integrates [Marksman](https://github.com/artempyanykh/marksman) language server into [coc.nvim](https://github.com/neoclide/coc.nvim) for delightful Markdown note taking experience.
6
+
7
+ https://user-images.githubusercontent.com/188642/174696988-98d3f458-7f91-4c06-83e2-9c2a6a6ca5ed.mp4
8
+
9
+ See the [project page](https://github.com/artempyanykh/marksman) for more detailed information.
10
+
11
+ ## Install
12
+
13
+ **CocInstall**:
14
+
15
+ > scoped packages
16
+
17
+ ```vim
18
+ :CocInstall @yaegassy/coc-marksman
19
+ ```
20
+
21
+ **vim-plug**:
22
+
23
+ ```vim
24
+ Plug 'yaegassy/coc-marksman', {'do': 'yarn install --frozen-lockfile'}
25
+ ```
26
+
27
+ ## Note
28
+
29
+ 1. **Get `marksman` server binary**.
30
+ The extension will try to automatically download Marksman language server
31
+ from GH releases. This is the easiest way to get started.
32
+
33
+ An alternative is to either download `marksman` binary from the [releases page][mn-releases] or to build `marksman` from source. Put it somewhere in your `PATH` and you should be good to go.
34
+ 2. **Add `.marksman.toml` to your workspace root folder**.
35
+ The extension is automatically activated only when `.marksman.toml` file is present. This is done to avoid running Zeta Note on random Markdown files, but rather only inside your notes folder.
36
+
37
+ ## Configuration options
38
+
39
+ - `marksman.enable`: Enable coc-marksman extension, default: `true`
40
+ - `marksman.customCommand`: allows to specify a custom command to start marksman. Mostly useful for development of marksman itself.
41
+ - `marksman.customCommandDir`: allows to specify a CWD for the command above. For development it's convenient to set the command to dotnet run and the command dir to the dir where marksman sources are.
42
+ - `marksman.trace.server`: Traces the communication between coc.nvim and the language server, valid option: `["off", "messages", "verbose"]`, default: `"off"`
43
+
44
+ ## Commands
45
+
46
+ - `marksman.restartServer`: Marksman: Restart Server
47
+ - `marksman.showOutputChannel`: Marksman: Show Output
48
+
49
+ ## Thanks
50
+
51
+ - <https://github.com/artempyanykh/marksman>
52
+ - <https://github.com/artempyanykh/marksman-vscode>
53
+
54
+ ## License
55
+
56
+ MIT
57
+
58
+ ---
59
+
60
+ > This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)