Skip to content

Commit 323d0b3

Browse files
committed
Update README
1 parent e8362d6 commit 323d0b3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ And don't forget to add `latex` to your `org-babel-load-languages` (below is for
3232
(perl . t)))
3333
```
3434

35-
### How to use?
35+
### Basic Usage
3636
First, turn on `org-edit-latex-mode`. Then you can edit a LaTeX fragment just
3737
as what you'll do to edit a src block.
3838

@@ -43,7 +43,26 @@ as what you'll do to edit a src block.
4343
Note that all above commands are built-in Org commands, so your current
4444
keybindings will probably do the job.
4545

46+
### TeX Master
47+
By default, `org-edit-latex` will generate a TeX master file automatically. The master file use the same settings as org preview. With a TeX master, it is possible to:
48+
49+
- Complete according to specified LaTeX packages.
50+
- Preview in the edit buffer.
51+
52+
Following snippet demonstrates how to set up a TeX master:
53+
```elisp
54+
(setq org-edit-latex-create-master t)
55+
(setq org-edit-latex-packages-alist
56+
'(("range-phrase=-,range-units=single" "siunitx")
57+
("" "mathptmx")))
58+
```
59+
60+
The master file locates in the same directory as the org file. You can update the master file with `org-edit-latex-update-master` after you change the preview settings.
61+
62+
When you are in the edit buffer, You can use `org-edit-latex-preview-at-point` to preview. By default, the keybinding of `preview-at-point` is remapped to this function.
63+
4664
### Change Log
65+
- 0.8.0 Add support for TeX-master; provide preview function.
4766
- 0.7.0 Fix a few bugs regarding latex fragment/environment with name/caption/attrib.
4867
- 0.6.3 Fix inline math issue caused by a bug from org.
4968
- 0.6.2 src blocks will be untouched.

0 commit comments

Comments
 (0)