Skip to content

Commit 4e2d569

Browse files
committed
Update README with project details and remove screenshot
Expanded the README to include project overview, features, setup instructions, and contact information. Removed the unused screenshot.png file from the repository.
1 parent 32ab2a0 commit 4e2d569

File tree

2 files changed

+134
-5
lines changed

2 files changed

+134
-5
lines changed

README.md

Lines changed: 134 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,136 @@
1+
# Mazino Space
2+
3+
Personal blog and portfolio website built with Jekyll and Beautiful Jekyll theme, hosted on GitHub Pages.
4+
5+
## About
6+
7+
This is my personal space on the internet where I share insights and write about topics that interest me, including:
8+
9+
- 💰 Money & Finance
10+
- ✈️ Travel
11+
- 🗣️ English
12+
- 💻 Code & Technology
13+
- 📚 Book Summaries
14+
15+
Visit the live site at: [https://mazino2d.github.io](https://mazino2d.github.io)
16+
17+
## Features
18+
19+
- Clean and responsive design using Beautiful Jekyll theme
20+
- Blog posts with tags and categories
21+
- About me page
22+
- Social media integration
23+
- Comment system support (Disqus, Giscus, Utterances)
24+
- Google Analytics integration
25+
- SEO optimized
26+
27+
## Technology Stack
28+
29+
- **Jekyll**: Static site generator
30+
- **Beautiful Jekyll**: Theme template
31+
- **GitHub Pages**: Hosting platform
32+
- **Markdown**: Content writing
33+
- **HTML/CSS/JavaScript**: Frontend
34+
35+
## Local Development
36+
37+
### Prerequisites
38+
39+
- Ruby (2.5.0 or higher)
40+
- RubyGems
41+
- Bundler
42+
- Jekyll
43+
44+
### Setup
45+
46+
1. Clone the repository:
47+
48+
```bash
49+
git clone https://github.com/mazino2d/mazino2d.github.io.git
50+
cd mazino2d.github.io
51+
```
52+
53+
2. Install dependencies:
54+
55+
```bash
56+
bundle install
57+
```
58+
59+
3. Run the local server:
60+
61+
```bash
62+
bundle exec jekyll serve
63+
```
64+
65+
4. Open your browser and navigate to:
66+
67+
```plaintext
68+
http://localhost:4000
69+
```
70+
71+
The site will automatically rebuild when you make changes to the source files.
72+
73+
## Project Structure
74+
75+
```plaintext
76+
.
77+
├── _config.yml # Site configuration
78+
├── _posts/ # Blog posts
79+
├── _layouts/ # Page layouts
80+
├── _includes/ # Reusable components
81+
├── _data/ # Data files
82+
├── assets/ # Static assets (CSS, JS, images)
83+
├── aboutme.md # About page
84+
├── tags.html # Tags page
85+
└── index.html # Homepage
186
```
2-
sudo apt install ruby-full build-essential zlib1g-dev
3-
sudo gem install jekyll bundler
4-
bundle install
5-
bundle exec jekyll serve
687

7-
```
88+
## Writing a New Post
89+
90+
1. Create a new Markdown file in the `_posts` directory with the naming format:
91+
92+
```plaintext
93+
YYYY-MM-DD-title.md
94+
```
95+
96+
2. Add front matter at the top of the file:
97+
98+
```yaml
99+
---
100+
layout: post
101+
title: Your Post Title
102+
subtitle: Optional subtitle
103+
tags: [tag1, tag2]
104+
comments: true
105+
---
106+
```
107+
108+
3. Write your content in Markdown below the front matter.
109+
110+
4. Commit and push to GitHub. The site will automatically rebuild.
111+
112+
## Configuration
113+
114+
Edit `_config.yml` to customize:
115+
116+
- Site title and description
117+
- Author information
118+
- Navigation links
119+
- Social media links
120+
- Analytics tracking
121+
- Comment system settings
122+
123+
## License
124+
125+
This project uses the Beautiful Jekyll theme. See [LICENSE](LICENSE) for details.
126+
127+
## Contact
128+
129+
- **Email**: <mazino2d@gmail.com>
130+
- **GitHub**: [@mazino2d](https://github.com/mazino2d)
131+
132+
## Acknowledgments
133+
134+
- [Beautiful Jekyll](https://beautifuljekyll.com/) - Theme by Dean Attali
135+
- [GitHub Pages](https://pages.github.com/) - Hosting platform
136+
- [Jekyll](https://jekyllrb.com/) - Static site generator

screenshot.png

-59.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)