Giter Club home page Giter Club logo

modulardissertationexample's Introduction

Creating a Modular Dissertation with Overleaf and Git

This accompanies the full description in this blog post.

The goal is to easily reuse content from journal or conference articles to create the chapters of your dissertation. This is accomplished by creating a dissertation project, then adding the chapters as fake git submodules, using the workflow described here.

TL;DR:

  • Submodules don't work in Git. Add fake repositories instead.
  • This means that the changes to the overall project will cascade to the submodules- watch out!
  • Sync the individual chapters with Overleaf before syncing the dissertation

Workflow:

  • Pull changes from chapter from Overleaf
  • Edit each chapter independently
  • Push updates to Overleaf
  • Push overall dissertation to Overleaf

Troubleshooting

File Type conflicts

Overleaf prevents you from pushing .log, .blg, .gz, .aux files. These need to be included in .gitignore.

If you've already committed with these files and are getting an error when you try to push, you can make git forget these files by doing git rm --cached <file> and then committing.

modulardissertationexample's People

Contributors

emunsing avatar

Watchers

James Cloos avatar  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.