https://github.com/vim-denops/denops-documentation

📖 Denops documentation
https://github.com/vim-denops/denops-documentation

denops documentation neovim vim

Last synced: 12 days ago
JSON representation

📖 Denops documentation

• Host: GitHub
• URL: https://github.com/vim-denops/denops-documentation
• Owner: vim-denops
• License: mit
• Created: 2021-07-10T07:58:53.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-27T08:00:28.000Z (4 months ago)
• Last Synced: 2024-08-01T17:36:09.495Z (3 months ago)
• Topics: denops, documentation, neovim, vim
• Language: JavaScript
• Homepage: https://vim-denops.github.io/denops-documentation/
• Size: 1.58 MB
• Stars: 9
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# denops-documentation

[![Test](https://github.com/vim-denops/denops-documentation/actions/workflows/test.yml/badge.svg)](https://github.com/vim-denops/denops-documentation/actions/workflows/test.yml)

[![Deploy](https://github.com/vim-denops/denops-documentation/actions/workflows/mdbook.yml/badge.svg)](https://github.com/vim-denops/denops-documentation/actions/workflows/mdbook.yml)

[![Documentation](https://img.shields.io/badge/denops-Documentation-yellow.svg)](https://vim-denops.github.io/denops-documentation/)

This is an official documentation of [denops.vim], an ecosystem of Vim/Neovim

which allows developers to write plugins in [Deno].

[denops.vim]: https://github.com/vim-denops/denops.vim

[deno]: https://deno.land

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](https://www.rust-lang.org/tools/install)

- [Deno](https://deno.land/)

Then, install [mdBook](https://github.com/rust-lang/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)](https://zenn.dev/lambdalisue/articles/b4a31fba0b1ce95104c9)

## License

The code follows MIT license written in [LICENSE](./LICENSE). Contributors need

to agree that any modifications sent in this repository follow the license.