|
| 1 | +# Gilbert Lab Website |
| 2 | + |
| 3 | +## For Content Editors (Non-Technical Users) |
| 4 | + |
| 5 | +This guide explains how to update website content. **You only need to edit files in the `content/` folder.** |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Quick Start |
| 10 | + |
| 11 | +1. Open the file you want to edit in any text editor |
| 12 | +2. Make your changes following the format examples below |
| 13 | +3. Save the file |
| 14 | +4. Refresh the website to see your changes |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## File Locations |
| 19 | + |
| 20 | +| What to Update | File to Edit | |
| 21 | +|----------------|--------------| |
| 22 | +| Lab events | `content/events.md` | |
| 23 | +| Protocols & resources | `content/protocols.md` | |
| 24 | +| Alumni list | `content/alumni.md` | |
| 25 | +| Publications | `content/publications.md` | |
| 26 | +| Research areas | `content/research.md` | |
| 27 | +| Team - Scientists | `content/team/scientists.md` | |
| 28 | +| Team - Students | `content/team/students.md` | |
| 29 | +| Team - Staff | `content/team/staff.md` | |
| 30 | +| PI info | `content/team/pi.md` | |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## How to Edit Each Section |
| 35 | + |
| 36 | +### Adding a Lab Event |
| 37 | + |
| 38 | +Open `content/events.md` and add a new event under "Upcoming" or "Past": |
| 39 | + |
| 40 | +```markdown |
| 41 | +### Event Title |
| 42 | +- date: January 20, 2026 |
| 43 | +- presenter: Person Name |
| 44 | +- topic: What the event is about |
| 45 | +``` |
| 46 | + |
| 47 | +### Adding a Protocol |
| 48 | + |
| 49 | +Open `content/protocols.md` and add: |
| 50 | + |
| 51 | +```markdown |
| 52 | +## Protocol Name |
| 53 | +- description: Brief description of what this protocol covers. |
| 54 | +- file: protocols/filename.pdf |
| 55 | +``` |
| 56 | + |
| 57 | +For external links instead of PDFs: |
| 58 | +```markdown |
| 59 | +## Resource Name |
| 60 | +- description: Brief description. |
| 61 | +- link: https://example.com/resource |
| 62 | +``` |
| 63 | + |
| 64 | +### Adding an Alumni |
| 65 | + |
| 66 | +Open `content/alumni.md` and add: |
| 67 | + |
| 68 | +```markdown |
| 69 | +## Person Name |
| 70 | +- years: 2020-2024 |
| 71 | +- current: Current Position, Company/University |
| 72 | +``` |
| 73 | + |
| 74 | +### Adding a Publication |
| 75 | + |
| 76 | +Open `content/publications.md` and add under the appropriate year: |
| 77 | + |
| 78 | +```markdown |
| 79 | +### Paper Title |
| 80 | +- authors: LastName A et al. |
| 81 | +- journal: Journal Name |
| 82 | +- doi: 10.1234/example.doi |
| 83 | +``` |
| 84 | + |
| 85 | +### Adding a Team Member |
| 86 | + |
| 87 | +Open the appropriate file in `content/team/`: |
| 88 | +- Scientists/Postdocs: `scientists.md` |
| 89 | +- Graduate Students: `students.md` |
| 90 | +- Staff: `staff.md` |
| 91 | + |
| 92 | +Add: |
| 93 | +```markdown |
| 94 | +## Person Name |
| 95 | +- role: Their Role |
| 96 | +- photo: images/team/filename.jpg |
| 97 | +``` |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## Adding Photos |
| 102 | + |
| 103 | +1. Put the photo file in the `images/team/` folder |
| 104 | +2. Reference it in the markdown file as `images/team/filename.jpg` |
| 105 | +3. Recommended: Square photos work best (e.g., 400x400 pixels) |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +## Important Notes |
| 110 | + |
| 111 | +- **Don't change the `##` symbols** - these mark section headers |
| 112 | +- **Keep the `- ` before each property** - this is required formatting |
| 113 | +- **Don't edit `index.html`** - that's the template file |
| 114 | +- **Don't edit files in `css/` or `js/`** - those control styling |
| 115 | + |
| 116 | +--- |
| 117 | + |
| 118 | +## Need Help? |
| 119 | + |
| 120 | +Contact the lab webmaster or see the [Markdown Guide](https://www.markdownguide.org/basic-syntax/) for formatting help. |
0 commit comments