Git Product home page Git Product logo

weblatex's Introduction

The WebLatex

WebLatex GitHub license GitHub forks GitHub stars

A complete alternative for Overleaf with VSCode + Web + Git Integration + Grammarly + Live Collaboration Support

Screenshot

Screenshot

Why

Do you use latex as your Resume builder / Research Project / Documentation / Article or any Documentation? Then you probably sometimes wondered in your life if you could use the advantages of git. You could just commit your changes and roll back to older versions anytime you like. When writing a journal, you suddenly remembered you need the section that you deleted earlier. What will you do?

Hasn't it occurred to you that if only you could use your favorite editor VSCode to write your documents? With all the settings you configured, themes you liked and the extensions you probably prefer over your toxic girlfriend?

Think of a moment, your thesis supervisor and co-supervisor wanted to make some changes to your document. What you will do? Email them your document and tell them to reply with the updated version? This is no 80's.

Or, you are in your car, away from your Laptop / Desktop. Suddenly remember you forgot to change the title of your document from "Loren Ipsum" to your actual document title. Won't it be great to modify your document On the Go with your phone? Or in a nerdy way, Apple Watch?

And do I need to tell you about the usefulness of Grammarly?

Yes! You can do all of these things now with Git, GitHub, Full VSCode Integration, Grammarly, Live Collaboration and Web Support - The WebLatex.

Just use overleaf

Yes, but

  • In overleaf, you have to pay 40$ to get the git feature which isn't even have the best or full git experience.
  • Pay 40$ to collaborate with more than 1 person
  • No VSCode

Installation Instructions

You can either fork this repository or just Use as a template. But you will not get latest updates if you use this as a template.

  1. Login or Sign Up to GitHub
  2. Fork this repository or just click Here. Or, If you want to use as a template just Click on Use this template and Create a new Repository
  3. Give it a name and select Create Fork
  4. Select <> Code > CodeSpaces > Create Codespace on Main tutorial
  5. It will start installing. You Have to wait for 2 mins in the first time. After that it will take 2/3 seconds to open up

Where is my PDF?

Generated PDFs will be saved to /PDF directory

Editor Instructions

  1. Pressing Ctrl+S will save the document and generate PDF in the PDF folder
  2. To check the generated PDF click on the PDF file. However It will take 20/30 seconds to open the preview for the first time. So, do not panic. After that, it will generate and preview the pdf instantly.
  3. Your code will be automatically saved and the PDF will generate automatically each time you edit something
  4. You can see all the error logs in the Terminal > Output > Latex Compiler as well as in the Latex Workshop sidebar
  5. If it shows Error showing PDF or in case of any inconvenience, just reload the browser or press Ctrl+R
  6. Just use it as you use Visual Studio Code
  7. Do not delete the devcontainer.json file.

To use with LuaLatex or any other Tex program

Add this line to your main .tex file

%!TEX program = <tex_program>

For example, to use LuaLatex:

%!TEX program = lualatex

Grammarly

This editor has built-in Grammarly support for .tex files. If you want to use Grammarly for other files, Go to ./.devcontainer/devcontainer.json and add your file extension in the

  "grammarly.files.include": ["*.md", ".YourFileExtension"]

And in case you do not want to use Grammarly for other files, add your file extension in the

  "grammarly.files.exclude": ["*.md", ".YourFileExtension"]

You can use Grammarly in any file apart from .tex files. Just press CTRL + SHIFT + P and search for Grammarly: Check text.

This editor uses Grammarly Free account to check grammar and spelling. However if you want to use your Grammarly Premium account, simply press CTRL + SHIFT + P and search for Grammarly: Login / Connect your account.

Live Collaboration

Just click on the Live Share Sidebar button and you are good to go Collaboration

PDF Viewer Dark Mode

The pdf viewer will preview the pdf in Dark Mode by default if your Operating System is in Dark Mode. To view the pdf in Normal mode in os-wide dark mode just remove or comment these lines from ./.devcontainer/devcontainer.json.

  "latex-workshop.view.pdf.color.dark.pageColorsBackground":"#171717",
  "latex-workshop.view.pdf.color.dark.pageColorsForeground":"#FFFFFF",
  "latex-workshop.view.pdf.color.dark.backgroundColor":"#171717",

Configuration

  • To change the output directory change the following properties in ./.devcontainer/devcontainer.json

    "latex-workshop.latex.outDir": "<YourDirectoryName>",
    "latex-workshop.latex.magic.args": ["-output-directory=<YourDirectoryName>",],
  • If you do not need the Live Collaboration at all, you can just remove the "ms-vsliveshare.vsliveshare" extension from the extension list in ./.devcontainer/devcontainer.json

    "extensions": ["ms-vsliveshare.vsliveshare",]
  • Other configurations (e.g. PDF Generation Delay, Auto Saving etc.) can be modified in ./.devcontainer/devcontainer.json. Check the Wiki

More Features and Configurations

There are a lot of features like

And a lot more.

All of the features and configurations can be found here.

Contribution

I am open to and request you to contribute to this project. You can just Create a new issue to let me know about your concern/requests or just send a pull request with your desired changes.

Credits

What's Next

  1. Will optimize the backend to decrease installation time and PDF showing time for the first time
  2. Documentation
  3. Release: Export PDF as a release version
  4. You tell me

Contact

  1. Send an email to [email protected]
  2. Facebook, LinkedIn

weblatex's People

Contributors

sanjib-sen avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.