repos / neovimcraft

README.md

 1# [neovimcraft.com](https://neovimcraft.com)
 2
 3A site dedicated to finding the best neovim plugins.
 4
 5## Requirements
 6
 7- deno
 8
 9## Want to submit a plugin?
10
11There are a couple of ways to add plugins to `neovimcraft`. Probably the
12simplest way would be to get your plugin added to
13[awesome-neovim](https://github.com/rockerBOO/awesome-neovim). We scrape that
14repo and is the primary data source for the plugin directory.
15
16If you'd like to suggest a plugin to `neovimcraft` directly then feel free to
17open a github issue or submit a PR after running the following command:
18
19```bash
20make resource
21```
22
23This command will step through the requirements for adding a resource to the
24site.
25
26## Want to submit a config?
27
28If you'd like to suggest a config to add to `neovimcraft.com/c` then feel free
29to submit a PR after running the following command:
30
31```bash
32make resource-config
33```
34
35This command will step through the requirements for adding a resource to the
36site.
37
38## nvim.sh
39
40Want to query neovimcraft from the terminal?
41
42```bash
43curl https://nvim.sh
44```
45
46https://github.com/neurosnap/nvim.sh
47
48## Developing
49
50You need to add a couple environment variables related to using the github api:
51
52```bash
53export GITHUB_ACCESS_TOKEN='xxx'
54export GITHUB_USERNAME='my-user'
55```
56
57To scrape and process all plugins, run:
58
59```bash
60make scrape
61```
62
63To build the static site, run:
64
65```bash
66make build
67```