Giter Club home page Giter Club logo

impecs's Introduction

Wowchemy Website Builder

Academic Template for Hugo

The Hugo Academic Resumé Template empowers you to create your job-winning online resumé and showcase your academic publications.

Check out the latest demo of what you'll get in less than 10 minutes, or view the showcase.

Wowchemy makes it easy to create a beautiful website for free. Edit your site in Markdown, Jupyter, or RStudio (via Blogdown), generate it with Hugo, and deploy with GitHub or Netlify. Customize anything on your site with widgets, themes, and language packs.

Crowd-funded open-source software

To help us develop this template and software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship.

Ecosystem

Screenshot

Demo image credits

Analytics

My own notes on quick start on a new Ubuntu computer

  1. Install Hugo
    • Download hugo_extended_VERSION_Linux-64bit.deb from https://github.com/gohugoio/hugo/releases. Note that you have to get the extended version for the website based on Wowchemy template to work.
    • Double click the .deb to install Hugo.
  2. Install Hugo's Go dependency, in a terminal
    sudo snap install --classic go
  3. Install the Hugo Academic CLI, in a terminal
    pip3 install -U academic
  4. Clone the repository from my Github, in a terminal
    git clone [email protected]:zhanlilz/zhanlilz.github.io.git

There are three branches,

  • Branch master: where I work on my website. Any changes made here are not deployed on my actual personal website. I should preview changes here using the script view.sh in the top directory.
  • Branch ready: where I merge proofed changes from the branch master. Any changes made here will trigger a Github workflow called gh-pages.yml that is saved under .github/workflows/. This workflow will generate the actual website files (all the HTML, CSS and such) and save/update them on the branch gh-pages.
  • Branch gh-pages: where the actual website files are stored and served by the Github Pages online under the URL of my personal webpage, https://zhanlilz.github.io/
  1. Preview the website, ini a terminal
    # In the top directory of the website repository
    ./view.sh
  2. Update the Wowchemy website components that my website uses, refer to https://wowchemy.com/docs/hugo-tutorials/update/

My own notes/tips on using the Academic Template

  • content/publications: Add a pdf under a publication folder (e.g., li-2018) named after this publication folder name (i.e., li-2018.pdf under content/publication/li-2018). The pdf button on the publication page will give users the pdf.

  • static/sub-folder-name: Files under this folder can be referred in the .md files as sub-folder-name/a-file

  • menus.yaml: Change the weight property of each menu item to change its display location on top of the home page. The larger the weight, the more right / further back the item will be displayed.

  • content/home/tags.md: This is the word cloud displayed under "Popular Topics" on the published page. It uses tags in all the .md files. Currently, most tags are from the index.md files in the publication folders.

  • Create a new post. For more details, https://wowchemy.com/docs/content/blog-posts/

    $ hugo new --kind post post/my-article-name
    
  • Create a new publication. For more details, https://wowchemy.com/docs/content/publications/

    • Import from a .bib file
      $ academic import --bibtex <path_to_your/publications.bib>
      
    • Mannually create one
      $ hugo new --kind publication publication/<my-publication>
      
  • Highlight an author name.

    • Edit the file content/authors/<first_name>-<last_name>/_index.md. In the front matter of the .md file, add/change highlight_name: true. If the author name in the index.md file of a publication appears as "first_name last_name", then this author name will be automatically recognized as the author in the folder content/authors/<first_name>-<last_name>. Otherwise, you need to use <first_name>-<last_name> in the index.md file of a publication.
    • Tip: according to https://wowchemy.com/docs/getting-started/get-started/, usernames (names of the folders under content/authors/) must be lowercase with any spaces replaced with hyphens (-).
  • Disable/Enable a widget (or visually a section on my website) For example, to disable the section Post,

    • go to content/home/posts.md, look for the following two lines
      # Activate this widget? true/false
      active: false
      If active: false, the widget/section will not show on the website. If active: true, it will show.
    • Do NOT forget to edit config/_default/menus.yaml to remove this section from the top menu if it was an item on the menu.

impecs's People

Contributors

zhanlilz avatar

Watchers

 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.