Skip to content

Commit c71a1e5

Browse files
committed
update README.md
1 parent 7e42974 commit c71a1e5

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ This website is built using [Jekyll](https://jekyllrb.com/) with the `github-pag
2727
│ ├── people.yml # Lab members data
2828
│ ├── publications.yml # Publications data
2929
│ └── news.yml # Lab news entries
30+
├── CNAME # Custom domain (lim.bio)
3031
├── Gemfile # Ruby dependencies
3132
├── Gemfile.lock # Locked dependency versions
3233
├── .gitignore # Git ignore rules
@@ -125,7 +126,7 @@ Add new items at the top of the list so the latest news appears first.
125126
The lab news page has an **Upcoming Events** section. Edit `_data/news.yml`:
126127

127128
- **Placeholder message** (when there are no events): change `events_placeholder`.
128-
- **Add events**: replace `upcoming_events: []` with a list of items, each with `date`, `title`, and optional `description` (markdown):
129+
- **Add events**: set `upcoming_events` to a list of items (or `[]` when none), each with `date`, `title`, and optional `description` (markdown):
129130

130131
```yaml
131132
upcoming_events:
@@ -144,7 +145,7 @@ upcoming_events:
144145

145146
### Page-Specific Changes
146147

147-
- **Content**: Edit the respective `.md` file in each directory
148+
- **Content**: Edit the respective `.md` file in each directory (People, Publications, and Lab News content live in `_data/people.yml`, `_data/publications.yml`, and `_data/news.yml`)
148149
- **Page Title/Description**: Edit the front matter at the top of each `.md` file
149150

150151
## 🌐 Custom Domain Configuration
@@ -213,6 +214,7 @@ We welcome contributions to improve the website! Here's how you can help:
213214
- Edit `_data/news.yml` and add a new entry under `recent_news`
214215
- Use `date`, `title`, and `paragraphs` (list of strings; markdown supported)
215216
- Add new items at the top so the latest news appears first
217+
- To add or edit **Upcoming Events**, edit `upcoming_events` in `_data/news.yml`
216218

217219
### Development Workflow
218220

0 commit comments

Comments
 (0)