This repository contains the source code for the OpenADMET website, which is built using Hugo and is deployed to GitHub Pages. We are using Cloudflare Pages to handle preview deployments of changes.
- Download and install Hugo.
- In the top-level directory, run
hugo server -D - Copy the Web address from this line (in this example, it is
localhost:1313):
Web Server is available at //localhost:1313/ (bind address 127.0.0.1)
- Paste the Web address into your browser
- Create a new branch with
git checkout -b <mybranch>, where<mybranch>is the name of your new branch. - Commit the changes (
git commit .) and push the repository to your branch (git push origin <mybranch>) - Open a PR and request review
Deploying is handled by a Github actions (see the .github/workflows/gh-pages.yml file). Commits/PRs into the main branch will trigger a new build. Once built, the action will push the content to the gh-pages branch, which the website is now served from.
The repository is also configured for Cloudflare Pages deployment with automatic PR previews. This provides:
- PR Previews: Every pull request gets a unique preview URL for testing changes
- Cleanup: Automatic removal of old preview deployments when PRs are closed
build-pr.yaml- Builds Hugo site for PR previewsstage-cloudflare.yaml- Deploys PR previews to Cloudflare stagingcleanup-cloudflare.yaml- Cleans up old preview deployments
- Add an image to
content/members/img/(e.g.firstname-lastname.jpg). - Add a YAML file
firstname-lastname.yamltodata/members/in the following format:
name: John D. Chodera
role: Primary Investigator
lab: Chodera lab
title: Associate Member
institution: Sloan Kettering Institute
img: john-chodera.jpg
webpage: "http://choderalab.org"
description: Automated Bayesian force field fitting and prediction of systematic error
google_scholar: http://goo.gl/qO0JW
ORCID: 0000-0003-0542-119X
twitter: jchodera
github: jchodera
active: trueYou can remove someone from appearing by setting active to false
- Add a YAML file to
/data/jobswith the following format
role: Role Title
title: Title
anchor: title-blah
institution: Placeholder Institution
location: Remote
investigator: Mary Appleseed
investigator_url: https://investigator.example
contact_email: email@example
availability: Immediate
status: open
summary: |
Job descriptionTo set the job to unavailable, modify the status tag to closed