Boost Your LaTeX Workflow with VS Code and GitHub

If you've ever struggled with the limited compiling time on Overleaf or faced issues with large image files, switching to Visual Studio Code (VS Code) could be a game-changer for your LaTeX projects. This guide will walk you through setting up a robust LaTeX environment using VS Code, GitHub , and a few essential tools.

Why Switch to VS Code for LaTeX?

• Unlimited Compiling Time: Unlike Overleaf, VS Code does not impose compiling limits.
• Better Handling of Large Files: Avoid issues with large image files by compiling locally.
• Team Collaboration: Work seamlessly with your team online using GitHub. Collaborate on the same LaTeX project with your team effortlessly.
• Safer Storage: With GitHub and local PC storage, your files are more secure.
• Synchronous Work: VS Code keeps your settings consistent across multiple PCs. Just clone your repository, and you're set to go.
• AI Assistance: GitHub Copilot can help you troubleshoot and enhance your LaTeX files.

Step-by-Step Setup Instructions

1. Create a GitHub Repository: Start by creating a private or public repository on GitHub. Follow this quickstart guide.

2. Upload Your LaTeX Files: If you already have a LaTeX project, upload it to your new GitHub repository. If not, you can create your LaTeX file later and upload it then.

3. Install VS Code: Download and install VS Code on your PC. For Linux, check here.

4. Install MiKTeX: Install MiKTeX from here. For Ubuntu users, use the command:

sudo apt-get install miktex        

5. Install Strawberry Perl: It is only necessary for Windows. Download and install Strawberry Perl.

6. Add Essential Extensions to VS Code: Install the following VS Code extensions to enhance your LaTeX editing experience:

• LaTeX
• LaTeX Workshop
• LaTeX Language Support
• Optional: LaTeX Previewer
• Optional: Tex Preview
• Rewrap

7. Log In to VS Code with GitHub: Set up Git in VS Code and log in with your GitHub account following this guide.

8. Clone Your GitHub Repository Locally: Clone your repository locally via VS Code as described here.

9. Open Your LaTeX Project: Open the main.tex file in VS Code. You can view your compiled PDF by dragging main.pdf to the right side of the screen to split the view.

10. Rewrap Your Text: Use Alt + Z to rewrap the text in your .tex file or select specific lines and press Alt + Q.

11. Leverage AI Support with GitHub Copilot (Optional):

• If you're a student or teacher, you can use GitHub Copilot for free. Apply for it here and follow the steps for activation.
• After activation, install GitHub Copilot and GitHub Copilot Chat extensions in VS Code.

By following these steps, you'll create a more efficient, collaborative, and flexible LaTeX workflow. Happy writing!

Feel free to reach out if you have any questions or need further assistance with your setup.

Erencan Bulut

Resources:

• Creating and Managing Repositories
• VS Code Setup
• MiKTeX Installation
• Strawberry Perl
• GitHub Copilot