Skip to content

Commit 983bb1d

Browse files
committed
☕ Remove Makefile and rewrite README.md
1 parent 2fa81e7 commit 983bb1d

File tree

4 files changed

+17
-39
lines changed

4 files changed

+17
-39
lines changed

.gitattributes

Lines changed: 0 additions & 1 deletion
This file was deleted.

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
/.tools
21
/book

Makefile

Lines changed: 0 additions & 25 deletions
This file was deleted.

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
[![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)
44
[![Documentation](https://img.shields.io/badge/denops-Documentation-yellow.svg)](https://vim-denops.github.io/denops-documentation/)
55

6-
This is an official documentation of [denops.vim][denops.vim], an ecosystem of
7-
Vim/Neovim which allows developers to write plugins in [Deno][Deno].
6+
This is an official documentation of [denops.vim], an ecosystem of Vim/Neovim
7+
which allows developers to write plugins in [Deno].
88

99
[denops.vim]: https://github.com/vim-denops/denops.vim
1010
[deno]: https://deno.land
@@ -20,26 +20,31 @@ To contribute, install the latest versions of the followings in your environment
2020
- [Rust](https://www.rust-lang.org/tools/install)
2121
- [Deno](https://deno.land/)
2222

23-
Then, install [mdBook](https://github.com/rust-lang/mdBook) and its plugins in
24-
`.tools` directory by
23+
Then, install [mdBook](https://github.com/rust-lang/mdBook) and its plugins
2524

2625
```
27-
make tools
26+
cargo install mdbook
27+
cargo install mdbook-alerts
2828
```
2929

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

3333
```
34-
make gen
34+
mdbook serve
3535
```
3636

37-
Note that all markdown files are formatted with
38-
[Deno's code formatter](https://deno.land/manual/tools/formatter) and checked by
39-
CI thus make sure to format codes by the following command
37+
Or build book into `book` directory
4038

4139
```
42-
make fmt
40+
mdbook build
41+
```
42+
43+
Don't forget to format Markdown files with `deno fmt` before sending a pull
44+
request.
45+
46+
```
47+
deno fmt
4348
```
4449

4550
## See also

0 commit comments

Comments
 (0)