summaryrefslogtreecommitdiff
path: root/support/texlab/docs
diff options
context:
space:
mode:
Diffstat (limited to 'support/texlab/docs')
-rw-r--r--support/texlab/docs/previewing.md12
-rw-r--r--support/texlab/docs/tectonic.md50
2 files changed, 45 insertions, 17 deletions
diff --git a/support/texlab/docs/previewing.md b/support/texlab/docs/previewing.md
index fbf6679760..6c667e0fd0 100644
--- a/support/texlab/docs/previewing.md
+++ b/support/texlab/docs/previewing.md
@@ -16,11 +16,17 @@ Previewing can be configured in a variety of ways:
because `texlab` does not get notified by `latexmk` when a document gets built.
Instead, you can use `texlab.build.onSave`.
-In the following sections, we will give forward search configurations for several popular viewers
-and Visual Studio Code.
-However, these settings can easily be adapted to other editors.
+In the following sections, we will give forward search configurations for several popular viewers.
If your viewer is not listed here, you can send us a pull request or create an issue.
+The inverse search configuration depends on the editor.
+In this section, we will give instructions for [Visual Studio Code](https://code.visualstudio.com/).
+However, these settings can easily be adapted to other editors.
+Some plugins can help with setting up inverse search:
+
+- `Neovim`: [`f3fora/nvim-texlabconfig`](https://github.com/f3fora/nvim-texlabconfig)
+- `Emacs`: [`ROCKTAKEY/lsp-latex`](https://github.com/ROCKTAKEY/lsp-latex#inverse-search)
+
---
## SumatraPDF
diff --git a/support/texlab/docs/tectonic.md b/support/texlab/docs/tectonic.md
index 38e0a7d636..e75fd4a3ee 100644
--- a/support/texlab/docs/tectonic.md
+++ b/support/texlab/docs/tectonic.md
@@ -1,26 +1,48 @@
-### Example: Using `tectonic`
+# Usage with `tectonic`
-[`tectonic`](https://tectonic-typesetting.github.io/) is an alternative to `latexmk`, built in Rust.
-You can quickly get started by changing `.vscode/settings.json` in your workspace to include the following:
+[`tectonic`](https://tectonic-typesetting.github.io/) is a modernized, alternative TeX engine.
+Most features of `texlab` work out of the box when using `tectonic`.
+To compile documents through `texlab`, you need to change the configuration.
+See `tectonic --help` for more information about the flags.
-```jsonc
+---
+
+**Hint:**
+
+Please make sure to set `texlab.auxDirectory` if you change the build directory with the `--outdir` argument.
+
+Also, `--keep-intermediates` is recommended because they allow `texlab`
+to find out the section numbers and show them in the completion.
+Without the `--keep-logs` flag, `texlab` won't be able to report compilation warnings.
+
+---
+
+## V2 CLI
+
+```json
+{
+ "texlab.build.executable": "tectonic",
+ "texlab.build.args": [
+ "-X",
+ "compile"
+ "%f",
+ "--synctex",
+ "--keep-logs",
+ "--keep-intermediates"
+ ]
+}
+```
+
+## V1 CLI
+
+```json
{
- // See `tectonic --help` for the format
"texlab.build.executable": "tectonic",
"texlab.build.args": [
- // Input
"%f",
- // Flags
"--synctex",
"--keep-logs",
"--keep-intermediates"
- // Options
- // OPTIONAL: If you want a custom out directory,
- // uncomment the following line.
- //"--outdir out",
]
- // OPTIONAL: The server needs to be configured
- // to read the logs from the out directory as well.
- // "texlab.auxDirectory": "out",
}
```