The page is based on the theme-research-block. Extended documentation here.
-
Run a GitHub codespace
. -
Create a new conda environment with Python 3.11
conda create --name myenv python=3.11
- Activate the environment
source activate myenv
- Install academic python library that will be used to add bib files to webpages.
pip install academic
Important Note After the initial setup, run the codespace using the green <> Code button at the top of the repo page.
- Run a GitHub codespace (green
<> Codebutton) - Run the server. Go to the terminal and hit the following:
./hugo server
Note!!! This must be run from the repo directory.
- Open the browser from the ports tab. Sometimes you may need to restart the server (CTRL+C and re-run step 2) and hard refresh (CTRL+F5) to see your changes.
- Activate the conda environment
source activate myenv
-
Add the .bib file (let's say my_bib.bib) for your publication to content/publication/bibdir
-
Import the .bib file
academic import content/publication/bibdir/my_bib.bib content/publication -v --compact
-
Edit the created index.md to add more info and additional links to pdf, code, etc.
-
Add an image called
featured.(jpg|png)to the created directory. -
Save your changes to the GitHub repo (see git helper).
Important Note: If the publication includes code and/or dataset, add
categories: ['Code']orcategories: ['Datasets']orcategories: ['Code', 'Datasets']accordingly so that the publication shows up in the Code and/or Datasets page.
Below you see the workflow you need to follow when you have added/edited files and you want to update the GitHub repo.
# See changes that you did (Optional)
git status
# Get the latest changes in case someone else has committed something in the meantime
git pull
# Stage changes to be committed
git add .
# Verify the staged files (Optional)
git status
# Commit changes
git commit -m "This is the commit message, e.g. Fix bug, Change profile, Add article"
# Push changes to the GitHub repo
git push