Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pakillo committed Oct 23, 2024
1 parent 42db7a5 commit 3d19b37
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,24 @@ Example website: https://pakillo.github.io/academic-website-template-Quarto/

1. Click on green button "Use this template" -> "Create a new repository"

2. Choose a name for your repository
2. Important: check 'Include all branches' when creating the repository (because we will need the 'gh-pages' branch to host the website).

3. Important: check 'Include all branches' when creating the repository (because we will need the 'gh-pages' branch to host the website).
3. Choose a name for your repository

4. Once your repo is created, remember to update the links and info in _quarto.yml, index.qmd, etc.
4. Once your repo is created, remember to update the links and info in `_quarto.yml`, `index.qmd`, etc.

5. With every new commit pushed to the 'main branch' the website will be updated automatically (using GitHub Actions). If that is not working, go to Settings -> GitHub Pages and check that it is configured as explained [here](https://quarto.org/docs/publishing/github-pages.html#source-branch). Otherwise the quarto rendering might be failing. Try runnning 'quarto render' locally in your computer for debugging.
5. With every new commit pushed to the 'main branch' the website will be updated automatically (using GitHub Actions). If that is not working, go to Settings -> GitHub Pages and check that it is configured as explained [here](https://quarto.org/docs/publishing/github-pages.html#source-branch). Otherwise the Quarto rendering might be failing. Try running 'quarto render' locally in your computer for debugging.


### Tips

In the 'R' folder there are a couple of R functions to help you population the Publications page.
In the 'R' folder there are a couple of R functions to help you populate the Publications page.

- `doi2md` will take a DOI (e.g. from a published paper) and produce the Markdown text ready to paste into `Publications.qmd`
- `doi2md` will take a DOI (e.g. from a published paper) and produce the Markdown text ready to paste into `Publications.qmd`. For example, running `doi2md("10.1111/ele.14141")` returns this text that you can directly paste into `Publications.qmd` (requires internet connection for retrieving the publication metadata):

- `scholar_pubs` will take a Google Scholar ID (e.g. mine is "LQQrHeEAAAAJ") and will generate a quarto file (named "publications.qmd" by default) with your full publication list as available in your Google Scholar profile. Note you could of course write similar functions to retrieve publications from your ORCID profile, Zotero database, etc.
Quintero, Rodríguez‐Sánchez, Jordano (2022) [Reciprocity and interaction effectiveness in generalised mutualisms among free‐living species](https://doi.org/10.1111/ele.14141). *Ecology Letters* 26 (1): 132-146

- `scholar_pubs` will take a Google Scholar ID (e.g. mine is "LQQrHeEAAAAJ") and will generate a Quarto file (named "publications.qmd" by default) with your full publication list as available in your Google Scholar profile. Note you could of course write similar functions to retrieve publications dynamically from your ORCID profile, Zotero database, etc.



0 comments on commit 3d19b37

Please sign in to comment.