Git Product home page Git Product logo

pubtex's Introduction

layout title
pubtex
PubTeX

PubTeX

This is a template for publicly hosting LaTeX files with GitHub actions.

It roughly works as follows:

  1. You write your latex files as you would normally
  2. Whenever you push your changes to main, your files are compiled and pushed to the gh-pages branch.
  3. You can now download them directly or publish the branch with GitHub Pages

You also get this nice front page for free :)

Some examples

Usage

  1. Use this template (you only need to include the main branch)
  2. List all .tex files you want to compile in .github/workflows/publish.yml under the files option
  3. If you want to generate handouts for some Beamer slides, list those files under the handouts option
  4. Create SSH deploy key
  5. (optional) Enable GitHub Pages for the gh-pages branch

Options

Name Description Default
deploy_key Deploy key used to deploy to GitHub Pages
files Space-separated list of files that should be compiled
handouts Space-separated list of Beamer files that handouts should be generated for
publish_dir The directory that should be published with GitHub Pages dist
index_page Path to the Markdown file that should be the main page README.md

pubtex's People

Contributors

jonhue 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.