-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
did zola build removed README.md added submodule for theme no readme new workflow
- Loading branch information
1 parent
848c111
commit 00f36ae
Showing
31 changed files
with
756 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
name: Build and Deploy Website | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
submodules: 'recursive' | ||
- name: Download Zola | ||
run: curl -fLsS "https://github.com/getzola/zola/releases/download/v0.19.1/zola-v0.19.1-x86_64-unknown-linux-gnu.tar.gz" | tar xzf - -C /usr/local/bin | ||
- name: Verify Zola binary | ||
run: echo "5a08302389d1ac6a54391984d414eba01b2b7b23d9ab410f51e87756ed0563bb /usr/local/bin/zola" | shasum -a 256 -b -c --strict | ||
- name: Build website | ||
run: zola build | ||
- name: Check for server side KaTeX | ||
run: grep -c "server_side_katex\s*=\s*true" config.toml | sed s/1/SERVER_SIDE_KATEX=true/ | sed s/0/SERVER_SIDE_KATEX=false/ >> $GITHUB_ENV | ||
- name: Setup Node | ||
uses: actions/setup-node@v4 | ||
if: ${{ env.SERVER_SIDE_KATEX == 'true' }} | ||
- name: Install KaTeX | ||
run: npm install katex | ||
if: ${{ env.SERVER_SIDE_KATEX == 'true' }} | ||
- name: Find KaTeX script directory | ||
run: if [ -d scripts ]; then echo "KATEX_SCRIPT_DIR=scripts"; else echo "KATEX_SCRIPT_DIR=themes/academic-paper/scripts"; fi >> $GITHUB_ENV | ||
if: ${{ env.SERVER_SIDE_KATEX == 'true' }} | ||
- name: Render KaTeX | ||
run: node $KATEX_SCRIPT_DIR/katex.js | ||
if: ${{ env.SERVER_SIDE_KATEX == 'true' }} | ||
- name: Copy KaTeX CSS and fonts | ||
run: cp node_modules/katex/dist/katex.min.css public; cp -r node_modules/katex/dist/fonts public/fonts | ||
if: ${{ env.SERVER_SIDE_KATEX == 'true' }} | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: ./public | ||
name: github-pages | ||
retention-days: 1 | ||
deploy: | ||
needs: build | ||
runs-on: ubuntu-latest | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "themes/academic-paper"] | ||
path = themes/academic-paper | ||
url = https://github.com/aterenin/academic-paper.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
base_url = "https://um-arm-lab.github.io/lucca" | ||
compile_sass = true | ||
build_search_index = false | ||
generate_feeds = false | ||
minify_html = true | ||
|
||
[markdown] | ||
highlight_code = true | ||
highlight_theme = "css" | ||
smart_punctuation = true | ||
|
||
[extra] | ||
favicon = false | ||
large_card = true | ||
footer_text = "This website is built using [Zola](https://www.getzola.org) and the [Academic Paper](http://github.com/aterenin/academic-paper/) theme, which is [designed to last](https://jeffhuang.com/designed_to_last/)." | ||
server_side_katex = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
+++ | ||
title = "Quantifying Aleatoric and Epistemic Dynamics Uncertainty via Local Conformal Calibration" | ||
[extra] | ||
authors = [ | ||
{name = "Luís Marques", url = "https://luis-marques.github.io/"}, | ||
{name = "Dmitry Berenson", url = "https://berenson.robotics.umich.edu/"} | ||
] | ||
venue = {name = "16th International Workshop on the Algorithmic Foundations of Robotics (WAFR) 2024", url = "https://www.algorithmic-robotics.org/"} | ||
buttons = [ | ||
{name = "Paper", url = "https://aterenin.github.io/academic-paper"}, | ||
{name = "PDF", url = "https://aterenin.github.io/academic-paper"}, | ||
{name = "Poster", url = "https://aterenin.github.io/academic-paper"}, | ||
] | ||
katex = true | ||
large_card = false | ||
favicon = false | ||
+++ | ||
|
||
Welcome to the [Academic Paper](https://github.com/aterenin/academic-paper) Zola theme! | ||
This theme is designed for hosting a blog-post-style website to facilitate scientific communication of your academic paper. | ||
|
||
# Features | ||
|
||
[Academic Paper](https://github.com/aterenin/academic-paper) is designed to be reasonably feature-complete. In particular, it supports: | ||
|
||
* A header with title, author, publication venue, year, and optional buttons for the paper, PDF download link, code, poster, and video. | ||
* Syntax highlighting via Zola, with a minimal CSS-based color theme. | ||
* Math rendering via KaTeX, compatible with both client-side and server-side rendering when configured appropriately. | ||
* Figures via a `figure(alt='Image alt text',src='path/to/image.png')` Zola shortcode, with support for optional captions, subfigures with optional subcaptions, implemented in responsive manner via flexbox. | ||
* Markdown footnotes via Zola. | ||
* Twitter Summary Card, OpenGraph, and JSON-LD metadata, to ensure the web pages produced are search-engine-friendly, and provide social media websites with a banner image link they can display when the website is shared on social media, with an implementation very similar to [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag). | ||
|
||
Let's demonstrate some of these: writing | ||
```tex | ||
$$ | ||
\int_{\mathbb{R}} \frac{1}{\sqrt{2\pi\sigma^2}} \exp\left(\frac{(x-\mu)^2}{-2\sigma^2}\right) \mathrm{d} x = 1. | ||
$$ | ||
``` | ||
in the Markdown file produces the output | ||
``` | ||
$$ | ||
\int_{\mathbb{R}} \frac{1}{\sqrt{2\pi\sigma^2}} \exp\left(\frac{(x-\mu)^2}{-2\sigma^2}\right) \mathrm{d} x = 1. | ||
$$ | ||
``` | ||
This theme also supports footnotes, and will style the heading that immediately precedes them.[^author] | ||
|
||
# Design and maintainability | ||
|
||
[Academic Paper](https://github.com/aterenin/academic-paper) is [designed to last](https://jeffhuang.com/designed_to_last/), meaning that it follows a number of best practices to ensure the websites it produces continue to work correctly in the indefinite future with minimal to no maintenance. | ||
In particular, this theme uses no JavaScript or CSS dependencies, except optionally KaTeX for math. | ||
Zola, with its Rust-based code, focus on simplicity, and one-binary design, is the clear static site generator of choice for such a theme. | ||
|
||
# BibTeX (Cite This) | ||
|
||
[^author]: This theme is designed and built by Alexander Terenin. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
.btn { | ||
display: inline-block; | ||
font-weight: 400; | ||
color: var(--color-white); | ||
text-align: center; | ||
vertical-align: middle; | ||
user-select: none; | ||
background-color: var(--color-btn); | ||
border: 1px solid var(--color-btn); | ||
padding: 0.375rem 0.75rem; | ||
font-size: 1rem; | ||
line-height: 1.5; | ||
border-radius: 1.5rem; | ||
transition: color 0.15s ease-in-out, background-color 0.15s ease-in-out, border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out; | ||
svg { | ||
width: 1.25rem; | ||
display: inline-block; | ||
vertical-align: text-bottom; | ||
} | ||
} | ||
|
||
.btn:hover { | ||
color: var(--color-white); | ||
background-color: color-mix(in srgb, var(--color-btn), var(--color-white) 15%); | ||
text-decoration: none; | ||
} | ||
|
||
@media (prefers-reduced-motion: reduce) { | ||
.btn { | ||
transition: none !important; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
:root { | ||
color-scheme: light dark; | ||
--color-text: #{$color-text}; | ||
--color-primary: #{$color-primary}; | ||
--color-light: #{$color-light}; | ||
--color-white: #{$color-white}; | ||
--color-black: #{$color-black}; | ||
--color-btn: #{$color-btn}; | ||
--color-border: #{$color-border}; | ||
@if $color-selection { --color-selection: #{$color-selection}; } | ||
} | ||
|
||
@media (prefers-color-scheme: dark) { | ||
:root { | ||
@if $color-text-dark { --color-text: #{$color-text-dark}; } | ||
@if $color-primary-dark { --color-primary: #{$color-primary-dark}; } | ||
@if $color-light-dark { --color-light: #{$color-light-dark}; } | ||
@if $color-white-dark { --color-white: #{$color-white-dark}; } | ||
@if $color-black-dark { --color-black: #{$color-black-dark}; } | ||
@if $color-btn-dark { --color-btn: #{$color-btn-dark}; } | ||
@if $color-border-dark { --color-border: #{$color-border-dark}; } | ||
@if $color-selection-dark { --color-selection: #{$color-selection-dark}; } | ||
} | ||
.dark-invert, pre.z-code code { | ||
filter: invert(90%) hue-rotate(180deg) sepia(10%); | ||
} | ||
img:not(.dark-invert) { | ||
filter: brightness(80%); | ||
} | ||
} | ||
|
||
@if $color-selection { | ||
::selection { | ||
background: var(--color-selection); | ||
} | ||
::-moz-selection { | ||
background: var(--color-selection); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
figure { | ||
display: flex; | ||
flex-direction: column; | ||
align-items: center; | ||
video { | ||
border: 1px solid var(--color-border); | ||
border-radius: 0.25rem; | ||
} | ||
img, video { | ||
margin-bottom: 0.5rem; | ||
} | ||
> div { | ||
display: flex; | ||
flex-direction: column; | ||
align-items: center; | ||
} | ||
figure { | ||
margin-left: 1rem; | ||
margin-right: 1rem; | ||
} | ||
} | ||
|
||
@media (min-width: $responsive-cutoff) { | ||
figure > div { | ||
flex-direction: row; | ||
align-items: baseline; | ||
justify-content: center; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
.content .footnote-definition { | ||
display: flex; | ||
> sup { | ||
margin-left: 1rem; | ||
margin-right: 0.5rem; | ||
vertical-align: baseline; | ||
font-size: inherit; | ||
} | ||
> sup:after { | ||
content: "."; | ||
} | ||
p { | ||
text-align: left; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.z-code { color: #334; } | ||
.z-comment { color: #99a; } | ||
.z-variable.z-parameter.z-function { color: #334; } | ||
.z-keyword { color: #a2a; } | ||
.z-variable { color: #d54; } | ||
.z-entity.z-name.z-function, .z-meta.z-require, .z-support.z-function.z-any-method { color: #08b; } | ||
.z-support.z-class, .z-entity.z-name.z-class, .z-entity.z-name.z-type.z-class { color: #b80; } | ||
.z-meta.z-class { color: #b80; } | ||
.z-keyword.z-other.z-special-method { color: #08b; } | ||
.z-storage { color: #a2a; } | ||
.z-support.z-function { color: #08b; } | ||
.z-string { color: #595; } | ||
.z-constant.z-numeric { color: #b80; } | ||
.z-none { color: #b80; } | ||
.z-none { color: #b80; } | ||
.z-constant { color: #b80; } | ||
.z-entity.z-name.z-tag { color: #d54; } | ||
.z-entity.z-other.z-attribute-name { color: #b80; } | ||
.z-entity.z-other.z-attribute-name.z-id, .z-punctuation.z-definition.z-entity { color: #b80; } | ||
.z-meta.z-selector { color: #a2a; } | ||
.z-markup.z-heading .z-punctuation.z-definition.z-heading, .z-entity.z-name.z-section { color: #08b; } | ||
.z-markup.z-bold, .z-punctuation.z-definition.z-bold { color: #a2a; } | ||
.z-markup.z-italic, .z-punctuation.z-definition.z-italic { color: #a2a; } | ||
.z-markup.z-raw.z-inline { color: #595; } | ||
.z-meta.z-link { color: #595; } | ||
.z-markup.z-quote { color: #595; } | ||
.z-markup.z-inserted { color: #9b7; } | ||
.z-markup.z-deleted { color: #d67; } | ||
.z-markup.z-changed { color: #db7; } | ||
.z-string.z-regexp { color: #595; } | ||
.z-constant.z-character.z-escape { color: #19b; } | ||
.z-invalid.z-illegal { color: #fff; background-color: #d67; } | ||
.z-invalid.z-broken { color: #fff; background-color: #db7; } | ||
.z-invalid.z-deprecated { color: #fff; background-color: #db7; } | ||
.z-invalid.z-unimplemented { color: #fff; background-color: #c7d; } |
Oops, something went wrong.