Skip to content

Commit a45a259

Browse files
ecisneros8claude
andcommitted
Add EDITING.md with placeholder customization guide
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 60093df commit a45a259

1 file changed

Lines changed: 153 additions & 0 deletions

File tree

EDITING.md

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Editing Guide — The Cisneros Group Website
2+
3+
All content lives in plain Markdown/HTML files. No build step needed locally —
4+
just edit, commit, and push; GitHub Pages rebuilds the site in ~1 minute.
5+
6+
---
7+
8+
## Site-wide settings → `_config.yml`
9+
10+
| Field | What it does |
11+
|-------|-------------|
12+
| `title` | Site name shown in the nav bar and browser tab |
13+
| `description` | Subtitle shown in the hero overlay on the home page |
14+
| `hero_image` | (commented out) Path to a static image that replaces the animation |
15+
16+
**Swapping the hero animation for a photo:**
17+
1. Drop your image at `assets/images/hero.jpg` (any format/name works).
18+
2. In `_config.yml`, uncomment and update:
19+
```yaml
20+
hero_image: assets/images/hero.jpg
21+
```
22+
3. Push — the animation is replaced with your image.
23+
24+
---
25+
26+
## Home page → `index.md`
27+
28+
### Profile photo
29+
1. Place your photo at `assets/images/profile.jpg`.
30+
2. In `index.md`, find the `<div class="profile-placeholder">` block and
31+
replace the entire `<div>…</div>` with:
32+
```html
33+
<img src="/assets/images/profile.jpg"
34+
alt="Dr. Esteban Cisneros"
35+
class="profile-photo">
36+
```
37+
38+
### Bio text
39+
Find the paragraph starting with `<strong>Dr. Esteban Cisneros</strong>` and
40+
edit the surrounding `<p>` tags. Plain text and basic HTML (`<strong>`,
41+
`<a href>`, `<br>`) work fine inside them.
42+
43+
### Research interests
44+
Each bullet is a `<li>` inside `<ul class="interests-list">`.
45+
Edit or add lines following this pattern:
46+
```html
47+
<li>Your research interest here</li>
48+
```
49+
50+
### News items
51+
Each item is a `<div class="news-item">` pair. Add a new one by copying an
52+
existing block and updating the date and text:
53+
```html
54+
<div class="news-item">
55+
<span class="news-date">Mar 2026</span>
56+
<span class="news-text">Your news text here.</span>
57+
</div>
58+
```
59+
Dates are freeform text — use whatever format you like.
60+
61+
### Apply section
62+
Edit the paragraphs inside `<div class="apply-box">` directly.
63+
64+
---
65+
66+
## Research page → `research.md`
67+
68+
### Overview paragraphs
69+
Edit the `<p>` tags inside the first `<section class="content-section">`.
70+
71+
### Adding a publication
72+
Copy one `<li class="pub-item">` block and fill in:
73+
- `href="https://doi.org/…"` — the real DOI link
74+
- `.pub-title` — full paper title
75+
- `.pub-authors` — author list (bold your name with `<strong>E. Cisneros</strong>` if you like)
76+
- `.pub-journal` — journal name, volume, pages, year
77+
78+
### Adding a project card
79+
Copy one `<div class="project-card">` block inside `.project-grid` and update
80+
the `<h3>` title, description `<p>`, and funding note.
81+
82+
---
83+
84+
## People page → `people.md`
85+
86+
Each person is a `<li class="person-item">`. There are four groups
87+
(Post-Docs, PhD, MS, Undergraduate). To add someone, copy a `<li>` block
88+
from the appropriate group and update:
89+
90+
- **Avatar initials** — the two-letter `<div class="person-avatar">` text
91+
- **Name + email** — `<a href="mailto:name@utk.edu">Full Name</a>`
92+
- **Role/topic** — the `<span class="person-role">` line
93+
94+
```html
95+
<li class="person-item">
96+
<div class="person-avatar">AB</div>
97+
<div class="person-info">
98+
<span class="person-name">
99+
<a href="mailto:asmith@vols.utk.edu">Alice Smith</a>
100+
</span>
101+
<span class="person-role">Dissertation: DNS of supersonic mixing layers</span>
102+
</div>
103+
</li>
104+
```
105+
106+
To **remove** a placeholder, delete the entire `<li>…</li>` block.
107+
108+
---
109+
110+
## Teaching page → `teaching.md`
111+
112+
Each course is a `<div class="course-card">`. To add a course, copy the
113+
existing card (or the commented-out template at the bottom of the file) and
114+
fill in:
115+
116+
```html
117+
<div class="course-card">
118+
<div class="course-code">ME 4XX · Undergraduate</div>
119+
<div class="course-title">Course Title Here</div>
120+
<p>Course description.</p>
121+
<p class="course-meta">
122+
<strong>Next offering:</strong> Spring 2027 &middot;
123+
<strong>Credits:</strong> 3 hrs
124+
</p>
125+
</div>
126+
```
127+
128+
---
129+
130+
## Quick-reference: where everything lives
131+
132+
```
133+
_config.yml ← site title, description, hero image toggle
134+
index.md ← Home: bio, research interests, news, apply
135+
research.md ← Research: overview, publications, projects
136+
people.md ← People: group members by degree level
137+
teaching.md ← Teaching: course cards
138+
assets/images/ ← Drop profile.jpg and hero.jpg here
139+
assets/css/custom.css ← All styles (colours, layout, typography)
140+
assets/js/simulation.js ← Hero animation (no need to touch this)
141+
```
142+
143+
---
144+
145+
## Workflow
146+
147+
```bash
148+
# Edit a file, then:
149+
git add <file>
150+
git commit -m "Update bio / add publication / etc."
151+
git push
152+
# Site rebuilds on GitHub Pages in ~1 minute.
153+
```

0 commit comments

Comments
 (0)