Skip to content

Commit

Permalink
Merge pull request #54 from jannis-baum/issue/52-aur-package
Browse files Browse the repository at this point in the history
AUR package
  • Loading branch information
jannis-baum authored Dec 4, 2023
2 parents b5ac1b4 + 9a585ff commit 9276f74
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ issue](https://github.com/jannis-baum/vivify/issues/new/choose) or
- syntax highlighting for code
- graphviz/dot graphs

### Editor Support

Vivify has a simple API to integrate your favorite editor so the viewer live
updates to any changes as you are typing and the scrolling is smoothly
synchronized!

See below for a list of existing editor plugins. In case your favorite editor is
not yet supported, use these as an example to write your own and add it to the
list!

#### Existing integration

- for Vim and Neovim: [vivify.vim](https://github.com/jannis-baum/vivify.vim)

### Config

Vivify will look for an optional config file at `~/.vivify/config.json` and
Expand Down Expand Up @@ -73,26 +87,22 @@ following optional keys:
available. Default Markdown extensions are `['markdown', 'md', 'mdown',
'mdwn', 'mkd', 'mkdn']`

## Usage
## Installation

- make sure you have [`jq`](https://github.com/jqlang/jq) installed
- download & unpack the latest release for your system (macOS or Linux)
- add the two executables to your `$PATH`
- run `viv <file>` to view `<file>`
Once you have Vivify installed, use it by running `viv` with any text file or
directory as an argument!

## Editor Support
### Packaged

Vivify has a simple API to integrate your favorite editor so the viewer live
updates to any changes as you are typing and the scrolling is smoothly
synchronized!
- [AUR](https://aur.archlinux.org/packages/vivify), e.g. install with `yay -S vivify`

See below for a list of existing editor plugins. In case your favorite editor is
not yet supported, use these as an example to write your own and add it to the
list!

### Existing integration
### Manual

- for Vim: [vivify.vim](https://github.com/jannis-baum/vivify.vim)
- make sure you have [`jq`](https://github.com/jqlang/jq) installed
- download & unpack the [latest
release](https://github.com/jannis-baum/vivify/releases) for your system
(macOS or Linux)
- add the two executables to your `$PATH`

## Get help

Expand Down

0 comments on commit 9276f74

Please sign in to comment.