https://github.com/rayslash/nixcats-book
A Comprehensive guide to configuring neovim using lua and nix
https://github.com/rayslash/nixcats-book
book gpl3 lua mdbook neovim nix nixcat nixcat-nvim
Last synced: 22 days ago
JSON representation
A Comprehensive guide to configuring neovim using lua and nix
- Host: GitHub
- URL: https://github.com/rayslash/nixcats-book
- Owner: RaySlash
- License: gpl-3.0
- Created: 2024-11-17T13:15:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-03T13:52:25.000Z (over 1 year ago)
- Last Synced: 2025-01-21T13:33:22.134Z (over 1 year ago)
- Topics: book, gpl3, lua, mdbook, neovim, nix, nixcat, nixcat-nvim
- Language: Nix
- Homepage: https://rayslash.github.io/nixcats-book/
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project README
Visit: [rayslash.github.io/nixcats-book/](https://rayslash.github.io/nixcats-book/)
This project is a flake. You can use `nix develop` or `direnv allow` if you have dir-env.
## Dev
There are several ways to render a book, but one of the easiest methods is to use the serve command, which will build your book and start a local webserver:
```shell
$ mdbook serve --open
```
The `--open` option will open your default web browser to view your new book. You can leave the server running even while you edit the content of the book, and mdbook will automatically rebuild the output and automatically refresh your web browser.
Check out the [CLI Guide](https://rust-lang.github.io/mdBook/cli/index.html) for more information about other mdbook commands and CLI options.
## Build
```shell
$ mdbook build
```