vim-denops / denops-documentation

📖 Denops documentation

denops-documentation

This is an official documentation of denops.vim, an ecosystem of Vim/Neovim which allows developers to write plugins in Deno.

Visit https://vim-denops.github.io/denops-documentation to see the content.

Contribution

Any contributions are welcome 👍

To contribute, install the latest versions of the followings in your environment

• Rust
• Deno

Then, install mdBook and its plugins

cargo install mdbook
cargo install mdbook-alerts

Once required tools are installed, execute the following command to serve the book on http://localhost:3000

mdbook serve

Or build book into book directory

mdbook build

Don't forget to format Markdown files with deno fmt before sending a pull request.

deno fmt

See also

• Semi-official documentation written in Japanese (日本語)
  Deno で Vim/Neovim のプラグインを書く (denops.vim)

License

The code follows MIT license written in LICENSE. Contributors need to agree that any modifications sent in this repository follow the license.

denops-documentation's Issues

Resources

Images used in documentation

Translate zenn content into English

Translate https://zenn.dev/lambdalisue/articles/b4a31fba0b1ce95104c9 into English

Upgrade dependencies and follow the latest best practice

• Use the latest unknownutil
• Use the latest denops_std
• Do NOT call initialization code in the main function