Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cbergman committed Dec 18, 2024
1 parent 294558a commit e903fa0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 66 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@ This lab website based on Aharoni lab site https://github.com/Aharoni-Lab/Aharon

# Instructions for updating / maintaining website

- After making changes, commit and push changes to github, then wait for a few minutes for changes to propagate to live site. If you want to generate a local version before pushing to github, run `bundle install` before pushing (I think.)
- After making changes, commit and push changes to github, then wait for a few minutes for changes to propagate to live site.
- If you want to generate a local version before pushing to github, [install jekyll via homebrew](https://jekyllrb.com/docs/installation/macos/), then cahnge directory into this git repo, then run `bundle install`, then run `bundle exec jekyll serve` and navigate to http://localhost:4000 to see the local preview.

## Home

- To update the home page, edit the [/index.md](https://github.com/bergmanlab/bergmanlab.github.io/blob/main/index.md) file
- To add a banner image, place it as /assets/images/banner.png
- To add a banner image, place it as `/assets/images/banner.png`
- To add a page to the navigation bar, add it to "main" in [/_data/navigation.yml](https://github.com/bergmanlab/bergmanlab.github.io/blob/main/_data/navigation.yml)

## Lab Personnel
- For people, keep their info updated in the [/_data/people.yml](https://github.com/bergmanlab/bergmanlab.github.io/blob/main/_data/people.yml) file
- If including image of the person, place the image in the /People/ folder
- Then to add them to the "People" page, add `{% include person.html name='INSERT_NAME_HERE' %}` to the appropriate section of [/People/index.md](https://github.com/bergmanlab/bergmanlab.github.io/blob/main/People/index.md) file
- If including an image of the person, place the image in the `/People` folder
- To add a person to the "People" page, add `{% include person.html name='INSERT_NAME_HERE' %}` to the appropriate section of the [/People/index.md](https://github.com/bergmanlab/bergmanlab.github.io/blob/main/People/index.md) file

## Research, Publications, and Join

- These pages can be edited at their respective /FOLDER/index.md files.

## Blog

- To create a blog post, add it to the /_posts/ folder as a md file with the name YYYY-MM-DD-POSTNAME.md
- To create a blog post, add it to the /_posts/ folder as a md file with the name YYYY-MM-DD-POSTNAME.md.
- make sure to keep a blank `tagline: " "` in the header to prevent the body of the post from showing up in the header.

61 changes: 0 additions & 61 deletions conda_env.yml

This file was deleted.

0 comments on commit e903fa0

Please sign in to comment.