Skip to content

Commit bda5ab9

Browse files
committed
📝 (docs): add comprehensive README
Add detailed README with project overview, features, and setup instructions.
1 parent 4b6a092 commit bda5ab9

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Socrabytes.github.io
2+
3+
My personal website/blog built with Hugo, featuring technical articles, projects, and more. Visit the live site at [socrabytes.github.io](https://socrabytes.github.io).
4+
5+
## 🚀 Features
6+
7+
- Built with [Hugo](https://gohugo.io/) static site generator
8+
- Theme: [Congo](https://github.com/jpanther/congo) with customizations
9+
- Comments powered by [Giscus](https://giscus.app/) (GitHub Discussions)
10+
- Full-text search functionality
11+
- Dark/Light mode support
12+
- Responsive design
13+
- Tags for content organization
14+
- Automatic image optimization
15+
- Code syntax highlighting
16+
17+
## 💻 Tech Stack
18+
19+
- **Static Site Generator**: Hugo
20+
- **Theme**: Congo
21+
- **Hosting**: GitHub Pages
22+
- **CI/CD**: GitHub Actions
23+
- **Comments**: Giscus (GitHub Discussions integration)
24+
- **Version Control**: Git
25+
26+
## 🛠️ Local Development
27+
28+
1. Clone the repository:
29+
```bash
30+
git clone https://github.com/socrabytes/socrabytes.github.io.git
31+
cd socrabytes.github.io
32+
```
33+
34+
2. Install Hugo (extended version required):
35+
```bash
36+
# For Ubuntu/Debian
37+
sudo apt install hugo
38+
# For other systems, see: https://gohugo.io/installation/
39+
```
40+
41+
3. Start the local development server:
42+
```bash
43+
hugo server -D
44+
```
45+
46+
4. View the site at: `http://localhost:1313`
47+
48+
## 🚀 Deployment
49+
50+
The site is automatically built and deployed using GitHub Actions whenever changes are pushed to the main branch. The workflow:
51+
52+
1. Triggers on push to main branch
53+
2. Sets up Hugo environment
54+
3. Builds the site
55+
4. Deploys to GitHub Pages
56+
57+
The GitHub Actions workflow configuration can be found in `.github/workflows/hugo.yaml`.
58+
59+
## 📝 Content Management
60+
61+
Content is written in Markdown and organized in the following sections:
62+
- `/content/tech-journal/` - Technical articles and blog posts
63+
- `/content/projects/` - Project showcases
64+
- `/content/about/` - About page
65+
- `/content/legal/` - Legal documents
66+
67+
## 💬 Comments
68+
69+
Comments are powered by Giscus, which integrates GitHub Discussions with the website. Comments are automatically synchronized between the website and GitHub Discussions, providing:
70+
- GitHub OAuth authentication for commenters
71+
- Full GitHub-based moderation tools
72+
- Automatic discussion creation for new pages
73+
- Reactions support
74+
75+
## 📄 License
76+
77+
- Code: [MIT License](LICENSE)
78+
- Content: See [CONTENT_LICENSE](CONTENT_LICENSE)
79+
80+
## 🤝 Contributing
81+
82+
While this is a personal website, if you find any issues or have suggestions, feel free to:
83+
1. Open an issue
84+
2. Submit a pull request
85+
3. Start a discussion using Giscus
86+
87+
---
88+
Built with ❤️ using Hugo

0 commit comments

Comments
 (0)