Skip to content
This repository has been archived by the owner on Mar 25, 2019. It is now read-only.

Commit

Permalink
Update README, gifs
Browse files Browse the repository at this point in the history
  • Loading branch information
donRaphaco committed Dec 7, 2016
1 parent d5b0554 commit 8758d66
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# NeoTex

This plugin compiles **latex** files **asynchronously** while edditing.

The PDF output gives a **live preview** of your document as you type.

You have the option to **highlight changes** from the previous save using latexdiff.

*This plugin is experimental and not well tested*

### live preview of a latex document
Expand All @@ -11,14 +14,17 @@ You have the option to **highlight changes** from the previous save using latexd
![Demo2 gif](img/demo_2.gif?raw=true)

## Installation

Install using the plugin manager you like.

For example [vim-plug](https://github.com/junegunn/vim-plug):
```
Plug 'donRaphaco/NeoTex', { 'for': 'tex' }
```
```vim
Plug 'donRaphaco/NeoTex', { 'for': 'tex' }
```
Do `:UpdateRemotePlugins` after installing or updating!

## Usage

For live previewing your latex file open the created PDF using a PDF viewer which supports auto reloading (I recommend zathura or evince).
The PDF is created in the same folder where your latex file is stored.

Expand All @@ -33,8 +39,13 @@ The PDF is created in the same folder where your latex file is stored.
| `g:neotex_pdflatex_add_options` | - | additional options for pdflatex (`-jobname=<filname>` and `-interaction=nonstopmode` is always set) |

## Commands

| Command | Description |
| ------------- | --------------------- |
| `:NeoTex` | Compile current buffer (asynchronously and without writing the file) |
| `:NeoTexOn` | Turn live compilation on (for current buffer) |
| `:NeoTexOff` | Turn live compilation off (for current bufffer) |

## Tipp

For better performance use a [precompiled preamble](http://tex.stackexchange.com/questions/79493/ultrafast-pdflatex-with-precompiling).
Binary file modified img/demo_1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/demo_2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8758d66

Please sign in to comment.