Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1 @@
docs/* linguist-generated=true
docs/**/* linguist-generated=true
18 changes: 0 additions & 18 deletions CONTRIBUTING.md

This file was deleted.

20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2021 Alisue, hashnote.net

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ tools: FORCE ## Install development tools
@cargo install mdbook-plantuml --root ${TOOLS}

fmt: FORCE ## Format code
@deno fmt --ignore=docs
@deno fmt src README.md

fmt-check: FORCE ## Format check
@deno fmt --ignore=docs --check
@deno fmt --check src README.md

gen: FORCE ## Generate codes
@${TOOLS}/bin/mdbook build
Expand Down
61 changes: 49 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,54 @@
# Denops.vim Documentation
# Denops Documentation

This repo is the source of documentation of `denops.vim`.
[![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)
[![Documentation](https://img.shields.io/badge/denops-Documentation-yellow.svg)](https://vim-denops.github.io/denops-documentation/)

Generated documentation is
[here](https://vim-denops.github.io/denops-documentation/). If you learn it in
Japanese, read an
[article](https://zenn.dev/lambdalisue/articles/b4a31fba0b1ce95104c9) written by
`Alisue`(@lambdalisue), the original author of `denops.vim`.
This is an official documentation of [denops.vim][denops.vim], an ecosystem of
Vim/Neovim which allows developers to write plugins in [Deno][Deno].

## How to contribute
[denops.vim]: https://github.com/vim-denops/denops.vim
[deno]: https://deno.land

Any Contributions for this repo are all welcome!
Visit https://vim-denops.github.io/denops-documentation to see the content.

The documents are auto-generated by `mdbook`. Read the
[`Contribution guide`](https://github.com/vim-denops/denops-documentation/blob/master/CONTRIBUTING.md)
for more info.
## 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 in
`.tools` directory by

```
make tools
```

Once required tools are installed, execute the following command to generate
static files in [`./docs`](./docs) from markdown files in [`./src`](./src).

```
make gen
```

Note that all markdown files are formatted with
[Deno's code formatter](https://deno.land/manual/tools/formatter) and checked by
CI thus make sure to format codes by the following command

```
make fmt
```

## See also

- Semi-official documentation written in Japanese (日本語)<br>
[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.
49 changes: 16 additions & 33 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading