Skip to content

Commit 6c0636f

Browse files
committed
update README.md to reflect custom domain configs
1 parent 6f08ccb commit 6c0636f

1 file changed

Lines changed: 38 additions & 2 deletions

File tree

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This is the official website for the Learning, Inference & Memory (LIM) Lab, led by Dr. Athena Akrami at the Sainsbury Wellcome Centre, UCL, London.
44

5+
🌐 **Live at**: [https://lim.bio](https://lim.bio)
6+
57
## 🚀 Built with Jekyll
68

79
This website is built using [Jekyll](https://jekyllrb.com/) with the `github-pages` gem, ensuring full compatibility with GitHub Pages. This provides:
@@ -52,10 +54,12 @@ This website is built using [Jekyll](https://jekyllrb.com/) with the `github-pag
5254
## 🛠️ Local Development
5355

5456
### Prerequisites
57+
5558
- Ruby 2.7 or higher
5659
- Bundler gem
5760

5861
### Setup
62+
5963
```bash
6064
# Install dependencies
6165
bundle install
@@ -72,6 +76,7 @@ The site will be available at `http://localhost:4000`
7276
## 📝 Adding Content
7377

7478
### Adding Lab Members
79+
7580
Edit `_data/people.yml` and add new members to the appropriate section:
7681

7782
```yaml
@@ -83,6 +88,7 @@ research_fellows:
8388
```
8489
8590
### Adding Publications
91+
8692
Edit `_data/publications.yml` and add new publications:
8793

8894
```yaml
@@ -96,48 +102,78 @@ published:
96102
```
97103

98104
### Adding News
105+
99106
Edit `labnews/index.md` and add new news items in the Recent News section.
100107

101108
## 🎨 Making Design Changes
102109

103110
### Global Changes
111+
104112
- **Header/Footer**: Edit `_includes/header.html` or `_includes/footer.html`
105113
- **Layout**: Edit `_layouts/default.html`
106114
- **Styling**: Edit `assets/css/style.css`
107115

108116
### Page-Specific Changes
117+
109118
- **Content**: Edit the respective `.md` file in each directory
110119
- **Page Title/Description**: Edit the front matter at the top of each `.md` file
111120

121+
## 🌐 Custom Domain Configuration
122+
123+
This site uses a custom domain `lim.bio` instead of the default `limlabswc.github.io`:
124+
125+
- **CNAME file**: Contains `lim.bio` to configure the custom domain
126+
- **Jekyll config**: `_config.yml` updated with the custom domain URL
127+
- **DNS records**: Configured in Cloudflare with GitHub Pages IPs
128+
- **HTTPS**: Automatically enforced through GitHub Pages
129+
130+
### DNS Configuration (Cloudflare)
131+
132+
- **A records**: 4 GitHub Pages IP addresses (`185.199.108.153`, `185.199.109.153`, `185.199.110.153`, `185.199.111.153`)
133+
- **CNAME**: `www` subdomain pointing to `limlabswc.github.io`
134+
- **Proxy status**: All records are proxied through Cloudflare for performance and security
135+
- **Subdomains**: `bcontrol.lim.bio` and `dosing.lim.bio` also point to the GitHub Pages site
136+
112137
## 🚀 Deployment
113138

114139
This site is automatically deployed to GitHub Pages when you push to the `main` branch. No manual deployment needed!
115140

141+
The site is live at [https://lim.bio](https://lim.bio) with HTTPS automatically enforced.
142+
116143
## 📋 Features
117144

145+
- ✅ **Custom Domain**: Professional `lim.bio` domain with HTTPS
146+
- ✅ **CDN Performance**: Cloudflare proxy for global fast loading
118147
- ✅ **Responsive Design**: Works on all devices
119148
- ✅ **SEO Optimized**: Proper meta tags and structure
120149
- ✅ **Fast Loading**: Static files, optimized for speed
121150
- ✅ **Easy Updates**: Data-driven content management
122151
- ✅ **Professional Design**: Clean, academic aesthetic
123152
- ✅ **Accessibility**: Proper semantic HTML and alt tags
153+
- ✅ **DDoS Protection**: Cloudflare security features
124154

125155
## 🔧 Technical Details
126156

157+
- **Domain**: `lim.bio` (custom domain via Cloudflare DNS)
158+
- **Hosting**: GitHub Pages with Jekyll
159+
- **CDN**: Cloudflare proxy for global performance
160+
- **SSL**: Automatic HTTPS enforcement
127161
- **Jekyll Version**: 3.10.0 (GitHub Pages compatible)
128162
- **Ruby Version**: 2.7+
129163
- **CSS**: Custom stylesheet with responsive design
130164
- **Images**: Optimized for web with proper alt tags
131165
- **Navigation**: Automatic active state highlighting
166+
- **DNS**: 4 A records for redundancy + CNAME for www subdomain
132167
- **GitHub Pages**: Fully compatible with automatic deployment
133168

134169
## 📞 Contact
135170

136171
For questions about the website or lab, contact:
137-
- **Email**: a.akrami@ucl.ac.uk
172+
173+
- **Email**: <a.akrami@ucl.ac.uk>
138174
- **Institution**: Sainsbury Wellcome Centre, UCL
139175
- **Location**: London, UK
140176

141177
---
142178

143-
*This website showcases the research and people of the LIM Lab, contributing to our understanding of learning, inference, and memory in the brain.*
179+
*This website showcases the research and people of the LIM Lab, contributing to our understanding of learning, inference, and memory in the brain.*

0 commit comments

Comments
 (0)