Skip to content

Commit

Permalink
starters: port Academic theme to Tailwind
Browse files Browse the repository at this point in the history
  • Loading branch information
gcushen committed May 19, 2024
1 parent 928399f commit 5ee9dc5
Show file tree
Hide file tree
Showing 66 changed files with 2,204 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/split-packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
matrix:
# define package to repository map
package:
- local_path: 'starters-bootstrap/academic-cv'
- local_path: 'starters/academic-cv'
split_repository: 'theme-academic-cv'
- local_path: 'starters/resume'
split_repository: 'theme-resume'
Expand Down
2 changes: 2 additions & 0 deletions starters/academic-cv/.github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: gcushen
custom: https://hugoblox.com/sponsor/
Binary file added starters/academic-cv/.github/preview.webp
Binary file not shown.
57 changes: 57 additions & 0 deletions starters/academic-cv/.github/workflows/import-publications.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Hugo Blox GitHub Action to convert Bibtex publications to Markdown-based webpages
name: Import Publications From Bibtex

# Require permission to create a PR
permissions:
contents: write
pull-requests: write

# Run workflow when a `.bib` file is added or updated in the `data/` folder
on:
push:
branches: ['main']
paths: ['publications.bib']

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
hugoblox:
if: github.repository_owner != 'HugoBlox'
runs-on: ubuntu-latest
steps:
- name: Checkout the repo
uses: actions/checkout@v3
- name: Set up Python 3.12
uses: actions/setup-python@v4
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install academic==0.10.0
- name: Run Academic (Bibtex To Markdown Converter)
# Check `.bib` file exists for case when action runs on `.bib` deletion
# Note GH only provides hashFiles func in `steps.if` context, not `jobs.if` context
if: ${{ hashFiles('publications.bib') != '' }}
run: academic import publications.bib content/publication/ --compact
- name: Create Pull Request
# Set ID for `Check outputs` stage
id: cpr
uses: peter-evans/create-pull-request@v5
with:
commit-message: 'content: import publications from Bibtex'
title: Hugo Blox Builder - Import latest publications
body: |
Import the latest publications from `publications.bib` to `content/publication/`.
将最新的出版物从`publications.bib`导入到`content/publication/`。
[View Documentation](https://github.com/GetRD/academic-file-converter)
base: main
labels: automated-pr, content
branch: hugoblox-import-publications
delete-branch: true
- name: Check outputs
if: ${{ steps.cpr.outputs.pull-request-number }}
run: |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
72 changes: 72 additions & 0 deletions starters/academic-cv/.github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Deploy website to GitHub Pages

env:
WC_HUGO_VERSION: '0.126.1'

on:
# Trigger the workflow every time you push to the `main` branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

# Provide permission to clone the repo and deploy it to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build website
build:
if: github.repository_owner != 'HugoBlox'
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
# Fetch history for Hugo's .GitInfo and .Lastmod
fetch-depth: 0
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: ${{ env.WC_HUGO_VERSION }}
extended: true
- uses: actions/cache@v3
with:
path: /tmp/hugo_cache_runner/
key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.mod') }}
restore-keys: |
${{ runner.os }}-hugomod-
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build with Hugo
env:
HUGO_ENVIRONMENT: production
run: |
echo "Hugo Cache Dir: $(hugo config | grep cachedir)"
hugo --minify --baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Generate Pagefind search index
run: npx pagefind --site "public"
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./public

# Deploy website to GitHub Pages hosting
deploy:
if: github.repository_owner != 'HugoBlox'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
22 changes: 22 additions & 0 deletions starters/academic-cv/.github/workflows/updater-wip.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Updater (WIP)

on:
schedule:
- cron: 0 0 * * 0
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

# Provide permission to clone the repo and deploy it to GitHub Pages
permissions:
contents: write

jobs:
update:
if: github.repository_owner == 'HugoBlox'
runs-on: ubuntu-latest
steps:
- uses: HugoBlox/gh-action-updater@v1
with:
feed-url: https://hugoblox.com/rss.xml
readme-section: news
branch: main
21 changes: 21 additions & 0 deletions starters/academic-cv/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023-present George Cushen (https://georgecushen.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
52 changes: 52 additions & 0 deletions starters/academic-cv/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# [Hugo Academic CV Theme](https://github.com/HugoBlox/theme-academic-cv)

[![Screenshot](.github/preview.webp)](https://hugoblox.com/templates/)

The Hugo **Academic CV Template** empowers you to easily create your job-winning online resumé, showcase your academic publications, and create online courses or knowledge bases to grow your audience.

[![Get Started](https://img.shields.io/badge/-Get%20started-ff4655?style=for-the-badge)](https://hugoblox.com/templates/)
[![Discord](https://img.shields.io/discord/722225264733716590?style=for-the-badge)](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
[![Twitter Follow](https://img.shields.io/twitter/follow/GetResearchDev?label=Follow%20on%20Twitter)](https://twitter.com/GetResearchDev)

**Trusted by 250,000+ researchers, educators, and students.** Highly customizable via the integrated **no-code, Hugo Blox Builder**, making every site truly personalized ⭐⭐⭐⭐⭐

Easily write technical content with plain text Markdown, LaTeX math, diagrams, RMarkdown, or Jupyter, and import publications from BibTeX.

[Check out the latest demo](https://academic-demo.netlify.app/) of what you'll get in less than 10 minutes, or [get inspired by our academics and research groups](https://hugoblox.com/creators/).

The integrated [**Hugo Blox Builder**](https://hugoblox.com) and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.

- 👉 [**Get Started**](https://hugoblox.com/templates/)
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
- 💬 [Chat with the **Hugo Blox Builder community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
- 🐦 Twitter: [@GetResearchDev](https://twitter.com/GetResearchDev) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithHugoBlox](https://twitter.com/search?q=%23MadeWithHugoBlox&src=typed_query)
- ⬇️ **Automatically import your publications from BibTeX** with the [Hugo Academic CLI](https://github.com/GetRD/academic-file-converter)
- 💡 [Suggest an improvement](https://github.com/HugoBlox/hugo-blox-builder/issues)
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/reference/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases)

## We ask you, humbly, to support this open source movement

Today we ask you to defend the open source independence of the Hugo Blox Builder and themes 🐧

We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.

### [❤️ Click here to become a Sponsor, unlocking awesome perks such as _exclusive academic templates and blocks_](https://hugoblox.com/sponsor/)

<!--
<p align="center"><a href="https://hugoblox.com/templates/" target="_blank" rel="noopener"><img src="https://hugoblox.com/uploads/readmes/academic_logo_200px.png" alt="Hugo Academic Theme for Hugo Blox Builder"></a></p>
-->

## Demo image credits

- [Unsplash](https://unsplash.com)

## Latest news

<!--START_SECTION:news-->

- [Easily make an academic CV website to get more cites and grow your audience 🚀](https://hugoblox.com/blog/easily-make-academic-website/)
- [What&#39;s new in v5.2?](https://hugoblox.com/blog/whats-new-in-v5.2/)
- [What&#39;s new in v5.1?](https://hugoblox.com/blog/whats-new-in-v5.1/)
- [Version 5.0 (February 2021)](https://hugoblox.com/blog/version-5.0-february-2021/)
- [Version 5.0 Beta 3 (February 2021)](https://hugoblox.com/blog/version-5.0-beta-3-february-2021/)
<!--END_SECTION:news-->
Empty file.
1 change: 1 addition & 0 deletions starters/academic-cv/assets/media/stacked-peaks.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions starters/academic-cv/config/_default/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Configuration of Hugo
# Guide: https://docs.hugoblox.com/tutorial/
# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings
# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/

# Website name
title: Hugo Academic CV Theme
# Website URL
baseURL: 'https://example.com/'

############################
## LANGUAGE
############################

defaultContentLanguage: en
hasCJKLanguage: false
defaultContentLanguageInSubdir: false
removePathAccents: true

############################
## ADVANCED
############################

build:
writeStats: true
enableGitInfo: false
summaryLength: 30
paginate: 10
enableEmoji: true
enableRobotsTXT: true
footnotereturnlinkcontents: <sup>^</sup>
ignoreFiles: [\.ipynb$, .ipynb_checkpoints$, \.Rmd$, \.Rmarkdown$, _cache$]
permalinks:
authors: '/author/:slug/'
disableAliases: true
outputs:
home: [HTML, RSS, headers, redirects, backlinks]
section: [HTML, RSS]
imaging:
resampleFilter: lanczos
quality: 80
anchor: smart
timeout: 600000
taxonomies:
author: authors
tag: tags
publication_type: publication_types
markup:
_merge: deep
highlight:
lineNos: false
security:
_merge: deep
sitemap:
_merge: deep
22 changes: 22 additions & 0 deletions starters/academic-cv/config/_default/languages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Languages
# Create a section for each of your site's languages.
# Documentation: https://docs.hugoblox.com/reference/language/

# Default language
en:
languageCode: en-us
# Uncomment for multi-lingual sites, and move English content into `en` sub-folder.
#contentDir: content/en

# Uncomment the lines below to configure your website in a second language.
#zh:
# languageCode: zh-Hans
# contentDir: content/zh
# title: Chinese website title...
# params:
# description: Site description in Chinese...
# menu:
# main:
# - name: 传
# url: '#about'
# weight: 1
27 changes: 27 additions & 0 deletions starters/academic-cv/config/_default/menus.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Navigation Links
# To link a homepage widget, specify the URL as a hash `#` followed by the filename of the
# desired widget in your `content/home/` folder.
# The weight parameter defines the order that the links will appear in.

main:
- name: Bio
url: /
weight: 10
- name: Papers
url: /#papers
weight: 11
- name: Talks
url: /#talks
weight: 12
- name: News
url: /#news
weight: 13
- name: Experience
url: experience/
weight: 20
- name: Projects
url: projects/
weight: 30
- name: Teaching
url: teaching/
weight: 40
25 changes: 25 additions & 0 deletions starters/academic-cv/config/_default/module.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
############################
## HUGO MODULES
## Install or uninstall themes and plugins here.
## Docs: https://gohugo.io/hugo-modules/
############################

imports:
- path: github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify
- path: github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind

# Install any Hugo Blox within the `hugo-blox/blox/` folder
mounts:
- source: hugo-blox/blox/community
target: layouts/partials/blox/community/
includeFiles: '**.html'
- source: hugo-blox/blox/all-access
target: layouts/partials/blox/
includeFiles: '**.html'
- source: hugo-blox/blox
target: assets/dist/community/blox/
includeFiles: '**.css'
- source: layouts
target: layouts
- source: assets
target: assets

0 comments on commit 5ee9dc5

Please sign in to comment.