deploy: a5c8dde

jonhue · Mar 17, 2024 · 3a6e3d1 · 3a6e3d1
commit 3a6e3d1
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 0 deletions.
diff --git a/_layouts/pubtex.html b/_layouts/pubtex.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    {% seo %}
+    <link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
+  </head>
+  <body>
+    <div class="container-lg px-3 my-5 markdown-body">
+      {{ content }}
+
+      {% if site.github.private != true and site.github.license %}
+      <div class="footer border-top border-gray-light mt-5 pt-3 text-right text-gray">
+        This site is open source. <a href="{{ site.github.repository_url }}">Improve this page</a>.
+      </div>
+      {% endif %}
+    </div>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script>
+    <script>anchors.add();</script>
+    {% if site.google_analytics %}
+    <script>
+      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+      ga('create', '{{ site.google_analytics }}', 'auto');
+      ga('send', 'pageview');
+    </script>
+    {% endif %}
+  </body>
+</html>
diff --git a/index.md b/index.md
@@ -0,0 +1,41 @@
+---
+layout: pubtex
+title: 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
+
+* [Paper](https://jonhue.github.io/pubtex/paper.pdf)
+* [Slides](https://jonhue.github.io/pubtex/slides.pdf)
+* [Handout](https://jonhue.github.io/pubtex/slides_handout.pdf)
+
+### Usage
+
+1. [Use this template](https://github.com/jonhue/pubtex/generate) (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](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-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` |
+| `pre_compile_command`  | Command to run before compiling LaTeX sources                     | `tlmgr update --self && tlmgr update --all` |
diff --git a/paper.pdf b/paper.pdf
diff --git a/slides.pdf b/slides.pdf
diff --git a/slides_handout.pdf b/slides_handout.pdf