Skip to content

Commit

Permalink
☕ Remove Makefile and rewrite README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdalisue committed Feb 4, 2024
1 parent 2fa81e7 commit 983bb1d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 39 deletions.
1 change: 0 additions & 1 deletion .gitattributes

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
/.tools
/book
25 changes: 0 additions & 25 deletions Makefile

This file was deleted.

29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
[![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/)

This is an official documentation of [denops.vim][denops.vim], an ecosystem of
Vim/Neovim which allows developers to write plugins in [Deno][Deno].
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
Expand All @@ -20,26 +20,31 @@ 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
Then, install [mdBook](https://github.com/rust-lang/mdBook) and its plugins

```
make tools
cargo install mdbook
cargo install mdbook-alerts
```

Once required tools are installed, execute the following command to generate
static files in [`./docs`](./docs) from markdown files in [`./src`](./src).
Once required tools are installed, execute the following command to serve the
book on http://localhost:3000

```
make gen
mdbook serve
```

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
Or build book into `book` directory

```
make fmt
mdbook build
```

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

```
deno fmt
```

## See also
Expand Down

0 comments on commit 983bb1d

Please sign in to comment.