Skip to content

Commit b750bdb

Browse files
committed
Updates README.md - it was about time
1 parent 2eedeed commit b750bdb

File tree

1 file changed

+154
-1
lines changed

1 file changed

+154
-1
lines changed

README.md

Lines changed: 154 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,154 @@
1-
This theme is based on the one made by [webjeda](http://webjeda.com/cards).
1+
# Jess Temporal's Blog & Portfolio
2+
3+
[![GitHub Pages](https://img.shields.io/badge/Hosted%20on-GitHub%20Pages-blue?logo=github)](https://jtemporal.com)
4+
[![Netlify Status](https://api.netlify.com/api/v1/badges/YOUR-NETLIFY-BADGE-ID/deploy-status)](https://app.netlify.com/sites/YOUR-NETLIFY-SITE/deploys)
5+
[![Jekyll](https://img.shields.io/badge/Built%20with-Jekyll-red?logo=jekyll)](https://jekyllrb.com/)
6+
7+
Personal blog and portfolio website of Jessica Temporal - Sr. Dev Advocate, podcaster, and creator. Built with Jekyll and hosted on GitHub Pages.
8+
9+
🌐 **Live Site**: [jtemporal.com](https://jtemporal.com)
10+
11+
## About
12+
13+
This website features:
14+
- Technical blog posts about Python, data science, Git, and open source
15+
- Portfolio showcasing projects and talks
16+
- Information about books authored by Jessica
17+
- Hacktoberfest project collection
18+
- Multi-language support (Portuguese and English)
19+
20+
## Tech Stack
21+
22+
- **Static Site Generator**: Jekyll
23+
- **Styling**: SCSS/Sass with Bootstrap
24+
- **Hosting**: GitHub Pages
25+
- **Domain**: Custom domain (jtemporal.com)
26+
- **Analytics**: Google Analytics & PostHog
27+
- **Comments**: Configured for comments system
28+
29+
## Features
30+
31+
- 📱 Responsive design
32+
- 🌍 Multi-language content (PT/EN)
33+
- 📖 Reading time estimation
34+
- 🎯 Project collection (Hacktoberfest)
35+
- 📝 Blog post pagination
36+
37+
## Local Development
38+
39+
### Prerequisites
40+
41+
- Ruby (version 2.7+)
42+
- Bundler gem
43+
- Git
44+
45+
### Setup
46+
47+
1. **Clone the repository**
48+
```bash
49+
git clone https://github.com/jtemporal/jtemporal.github.io.git
50+
cd jtemporal.github.io
51+
```
52+
53+
2. **Install dependencies**
54+
```bash
55+
bundle install
56+
```
57+
58+
3. **Run the development server**
59+
```bash
60+
bundle exec jekyll serve
61+
```
62+
63+
Or for development with the dev config:
64+
```bash
65+
bundle exec jekyll serve --config _dev_config.yml
66+
```
67+
68+
4. **View the site**
69+
Open your browser to `http://localhost:4000`
70+
71+
### Development Commands
72+
73+
- **Build the site**: `bundle exec jekyll build`
74+
- **Serve with drafts**: `bundle exec jekyll serve --drafts`
75+
- **Serve with future posts**: `bundle exec jekyll serve --future`
76+
- **Clean build files**: `bundle exec jekyll clean`
77+
78+
## Content Structure
79+
80+
```text
81+
├── _posts/ # Blog posts (markdown files)
82+
├── _books/ # Book collection (PT/EN)
83+
├── _drafts/ # Draft posts
84+
├── _hacktoberfest_projects/ # Hacktoberfest project collections
85+
├── _includes/ # Reusable templates
86+
├── _layouts/ # Page layouts
87+
├── _sass/ # Sass stylesheets
88+
├── images/ # Image assets
89+
├── slides/ # Presentation slides
90+
└── pages/ # Static pages (about, contact, etc.)
91+
```
92+
93+
## Writing Posts
94+
95+
Create new posts in the `_posts/` directory with the format:
96+
```text
97+
YYYY-MM-DD-post-title.md
98+
```
99+
100+
### Front Matter Template
101+
102+
```yaml
103+
---
104+
layout: post
105+
title: "Your Post Title"
106+
date: 2025-08-30
107+
image: "path/to/featured-image.jpg"
108+
tags: [tag1, tag2, tag3]
109+
lang: en # or pt
110+
---
111+
112+
Your post content here...
113+
```
114+
115+
## Collections
116+
117+
### Books
118+
Book information is stored in `_books/` with separate folders for English (`en/`) and Portuguese (`pt/`) content.
119+
120+
### Hacktoberfest Projects
121+
Organized by programming language in `_hacktoberfest_projects/` directory.
122+
123+
## Configuration
124+
125+
- **Main config**: `_config.yml`
126+
- **Development config**: `_dev_config.yml`
127+
- **Styling**: Custom Bootstrap theme in `_sass/`
128+
129+
## Contributing
130+
131+
1. Fork the repository
132+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
133+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
134+
4. Push to the branch (`git push origin feature/amazing-feature`)
135+
5. Open a Pull Request
136+
137+
## Theme
138+
139+
This theme is based on the one made by [webjeda](http://webjeda.com/cards) and has been extensively customized.
140+
141+
## License
142+
143+
This project is open source. Please see the [LICENSE.md](LICENSE.md) file for details.
144+
145+
## Contact
146+
147+
- **Website**: [jtemporal.com](https://jtemporal.com)
148+
- **Email**: hello at jtemporal.com
149+
- **Twitter**: [@jesstemporal](https://twitter.com/jesstemporal)
150+
- **GitHub**: [@jtemporal](https://github.com/jtemporal)
151+
152+
---
153+
154+
Made with ❤️ by [Jessica Temporal](https://jtemporal.com)

0 commit comments

Comments
 (0)