Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.44 KB

README.md

File metadata and controls

40 lines (28 loc) · 2.44 KB
Raw

vscode-btex

VSCode integration for bTeX.

Demo

  • Use the "Compile and preview bTeX" button in the editor navigation bar to start. The rendered content will update on save.
  • Double click in the preview tab to jump to the corresponding line in the source code.
  • The "Export bTeX to PDF/printer" button will open a browser with a printing dialog. After you choose a suitable configuration, you can either print or export to PDF.

Features

  • Syntax highlights. (Needs more testing)
  • Inverse search.
  • Compiles the bTeX file and show the preview on save.
  • Exports the result to PDF or printer.
  • Use \includegraphics{relative path} to include graphics in the workspace folder. Weblinks and base64-encoded URIs are also accepted.

Requirements

  • Install optionally tikz2svg. This is used to render TikZ images.

Extension Settings

  • btex.command and btex.directory: Used to specify the location of tikz2svg. You can leave blank to not let the plugin start up tikz2svg for you.
  • btex.invertAll: Color settings for formulas, see settings description. It is only relevant in dark themes.

Known Issues

  • If there is an error "tikz2svg server exited with code 1 and signal null", it is most probably because there is another program (possibly another tikz2svg server) running, using the port 9292.
    • If you can still render tikz pictures, and you are sure you didn't start a tikz2svg server yourself, then this is because vscode failed to shut down the tikz2svg server last time. You can use the extension normally, and manually kill the tikz2svg server when you don't need it.
    • If you cannot render tikz pictures, check out which process is using the 9292 port, either terminate it or convince it to use another port instead.
  • Wiki templates do not work, because they are stored on wiki servers. I'm not going to implement local wiki templates either. Similarly wiki-style links will show up as blue but don't link anywhere. This means that images (which currently uses MediaWiki syntax) doesn't work. I might try to implement that, or I can get some separate image mechanics in.
  • Collapsible proofs do not work (yet) because it requires more javascript machinery.
  • \includegraphics doesn't work in formulas.
  • Inverse search doesn't work with graphics. A workaround is to click on elements close to them, e.g. captions.

Release Notes