Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Using Overleaf as your TeX editor but getting your files to Github

git + overleaf + github

Setup

Connect Overleaf and your local repo

  1. Make a new project on Overleaf.
  2. In the share menu, copy the link from "Clone with git"
  3. On your computer:
    • use cd to navigate to where you want to put your project
    • type mkdir and then the name of the project
    • cd into that project
    • do git init
    • do git remote add overleaf with the link you copied
    • so overall this would like something like this
cd ~/Desktop
mkdir overleaf-project
cd overleaf-project
git init
git remote add overleaf https://git.overleaf.com/11205025wxdxfsqpxytc
git pull overleaf master

Connect your local repo and Github

  1. Make a new repo on Github
  2. Copy the git remote link
  3. On your computer:
git remote add github https://github.com/jnaecker/overleaf-project.git
git push github master

Regular Workflow

  1. Make some changes on Overleaf
  2. On your computer (while in the local repo directory), run
git pull overleaf master
git push github master

Any changes you made on overleaf should now be on both your local repo and on Github!

If you want to make changes via your local repo, just push to both remote repos (after staging and committing locally):

git add .
git cm "Adding stuff from local repo"
git push overleaf master
git push github master

You may also want to check out this paper which explains how you get set up git to push to both Overleaf and Github with just one git push command.

@vbuza

This comment has been minimized.

Copy link

vbuza commented Jul 16, 2019

Is there a way to add a comment to these steps?

git pull overleaf master
git push github master

Otherwise the commit will just have a generic "Update on Overleaf."

@jnaecker

This comment has been minimized.

Copy link
Owner Author

jnaecker commented Jul 20, 2019

I am not sure, but I don't believe comments can be added on the push or pull steps.

@da5nsy

This comment has been minimized.

Copy link

da5nsy commented Jul 24, 2019

This is now (since not sure when?) possible to do within Overleaf (you can push/pull from GH directly).

@jnaecker

This comment has been minimized.

Copy link
Owner Author

jnaecker commented Aug 5, 2019

Thanks Danny.

Just curious: How did both of you come across this gist? Very glad if it was helpful for anyone, but I'm shocked multiple people have even seen it.

@da5nsy

This comment has been minimized.

Copy link

da5nsy commented Aug 5, 2019

I had messed up the git I was using with Overleaf and was googling around looking for a solution. I think this was one of the top results for Overleaf + Github

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.