This repository provides a website for the program: Heart Equity and Access - Responsible Tranplantation.
Maillist for internal communication: aimahead-heart@googlegroups.com
Purpose: If you want to email to the whole project team, please send an email to this google group.
Gmail Account: aimaheadheart@gmail.com
Purpose: This account is created for the student to manage the mailist, website and the corresponding GitHub repository. Please send an email to this account if you have any issues regarding the project access and management. Otherwise, please use the maillist above for project-related communications.
GitHub Account: aimaheadheart
GitHub URL: https://github.com/aimaheadheart
Purpose: To manage our code, documents, and version control efficiently.
Website URL: https://aimaheadheart.github.io
Purpose: Serves as the public face of our project, showcasing our work and team.
- Homepage: Provides our project description.
- People: List all the related people including their images, profiles, affiliations, etc..
- Publications: List all the related publications related to organ transplant.
- Demos: List related demos from our group.
- Activities: Because we may organize some activities later, so put some on the page. We now list one previous tutorial on that, data-centric AI at KDD.
- Collaborations: List the icon of all the institutes, tamu, rice, etc. And will also list the icons of the funding agencies, NIH, AIM-AHEAD.
After being set up as a collaborator of the project, you can use your GitHub account to access and modify the repository files to update the website. All changes for updating are on the master branch of the repository. You don’t need to create new branches. For the stability of the website, please do not modify folders or files that have not been mentioned without discussion.
/templates: Contains markdown template files for website updating./_tabs: Contains markdown files corresponding to each subpage of the website sidebar./_posts: Contains markdown files corresponding to each activity post of the "Activities" subpage./assets/img/demos: Contains figures used on the "Demos" subpage./assets/img/activities: Contains figures used by activity posts of the "Activities" subpage.
We can easily update the "Publications" subpage by modifying the /_tabs/publications.md file.
As shown in the figure, we need to click on this button to download the file first. Then we can change the contents locally.
Please do not modify the first five lines of the file, which are not relevant to the publication list:
---
# the default layout is 'page'
icon: fas fa-file-contract
order: 2
---
Next, you can modify the publication list according to markdown syntax and the template file /templates/publications-template.md.
Lastly, in the folder /_tabs, by clicking the "Add file" button and choose "Upload files", you can upload the new publications.md file to replace the old one and complete the updating.
We can easily update the "Demos" subpage by modifying the /_tabs/demos.md file.
As shown in the figure, we need to click on this button to download the file first. Then we can change the contents locally.
Also, please do not modify the first five lines of the file, which are not relevant to the demo list:
---
# the default layout is 'page'
icon: fas fa-laptop-code
order: 3
---
Next, you can modify the demo list according to markdown syntax and the template file /templates/demos-template.md. If you want to add figures related to the demo, please put the figure in the folder /assets/img/demos and use it following the markdown syntax and the template file.
Lastly, in the folder /_tabs, by clicking the "Add file" button and choose "Upload files", you can upload the new demos.md file to replace the old one and complete the updating.
Different from the above, "Activities" subpage looks like a news list, and each activity post has its own markdown file. We can update the "Activities" subpage by adding new markdown files to the /_posts folder. Figures needed can be add to the /assets/img/demos folder.
Activities are organized by date like news. Please create a new file named YYYY-MM-DD-TITLE.md (e.g., 2023-12-01-Hello-World.md) and put it in the /_posts of the root directory. The first part of the file name must use a strict date format.
This time you need to modify the first several lines of the markdown file:
---
title: Title of the Activity Post
date: YYYY-MM-DD HH:MM:SS +/-TTTT
categories: [TOP_CATEGORIE] or [TOP_CATEGORIE, SUB_CATEGORIE]
tags: [tag] # TAG names should always be lowercase
pin: true # Should always be true, otherwise the post will be hidden
image: # add if needed
path: /assets/img/activities/figure.png # add if needed
---
Please note that the date in the file name of the new activity post and the date at the beginning of the file cannot be in the future, otherwise this post will not be displayed.
Next, you can modify the demo list according to markdown syntax and the template file /templates/2023-12-01-post-template.md. If you want to add figures related to the activity post, please put the figure in the folder /assets/img/activities and use it following the template.
Lastly, in the folder /_posts, by clicking the "Add file" button and choose "Upload files", you can upload the new activity post YYYY-MM-DD-TITLE.md. file and complete the updating.
The template file /templates/2023-12-01-markdown-text-and-typography.md provides more complex markdown functions and syntax for website updating. Please read it if needed.