Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for setting up VSCode #108

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Nokel81
Copy link

@Nokel81 Nokel81 commented Nov 1, 2023

This has been tested on Windows 10 using texlive 2023 and gregorio 6

Copy link
Contributor

@rpspringuel rpspringuel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not having VSCode, I can't actually test this so I'll trust that it works.

{
"name": "lualatex",
"command": "lualatex.exe",
"args": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand correctly, this will work only with the Gregorio that comes packaged with TeXLive. Gregorio updates installed outside the TeXLive system requires the --shell-escape option to be active, which I don't see in this configuration.

Now, since we haven't had such an update in several years now, it may not be worth mentioning here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was getting a warning for providing the --shell-escape option which is why I didn't provide it here. I can add a note about this being specifically for the TeXLive version



<p>The editor must be correctly configured according to the instructions for <a href="./configuration-texworks.html"><span class="tex">T<span class="epsilon">e</span>X</span>works</a> or <a href="./configuration-texshop.html"><span class="tex">T<span class="epsilon">e</span>X</span>Shop</a>. These instructions can be easily adapted for other tools using <span class="tex">T<span class="epsilon">e</span>X</span>Shop markup, such as the <a href="https://github.com/SublimeText/LaTeXTools"><span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> Tools for SublimeText</a>.</p>
<p>The editor must be correctly configured according to the instructions for <a href="./configuration-texworks.html"><span class="tex">T<span class="epsilon">e</span>X</span>works</a> or <a href="./configuration-texshop.html"><span class="tex">T<span class="epsilon">e</span>X</span>Shop</a> or <a href="./configuration-vscode.html" >VSCode</a>. These instructions can be easily adapted for other tools using <span class="tex">T<span class="epsilon">e</span>X</span>Shop markup, such as the <a href="https://github.com/SublimeText/LaTeXTools"><span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> Tools for SublimeText</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the addition of a new editor, this paragraph starts feeling cumbersome to me as it is currently formatted. Perhaps we should consider changing the format to include a bulleted list of the links to configuration instructions?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants