π Complete Setup Guide for Your Jekyll Blog
π Complete Setup Guide for Your Jekyll Blog
Your minimalist Jekyll blog is now ready! Follow this guide to get it running on GitHub Pages.
π Whatβs Been Set Up
β
Minimalist Theme: βno-style-pleaseβ theme for clean, fast loading
β
Chronological Posts: Homepage displays posts in reverse chronological order
β
Tagging System: Full tagging functionality with dedicated tags page
β
Comments Ready: Giscus integration for GitHub Discussions-based comments
β
GitHub Pages Compatible: Configured for seamless GitHub Pages deployment
β
Sample Content: 4 sample blog posts with various tags
β
Responsive Design: Works perfectly on all devices
π οΈ Immediate Setup Steps
1. Update Personal Information
Edit _config.yml
and update these fields:
title: Your Name
email: your-email@example.com
description: Your blog description
github_username: your-github-username
twitter_username: your-twitter-handle # optional
2. Update About Page
Edit about.markdown
and replace placeholder information with your details:
- GitHub username
- Email address
- Twitter handle
- Personal bio and interests
3. GitHub Repository Setup
- Create a new GitHub repository (or use existing one)
- Push your code:
git add . git commit -m "Initial blog setup" git push origin main
4. Enable GitHub Pages
- Go to your repository on GitHub
- Click Settings β Pages
- Under βSourceβ, select βDeploy from a branchβ
- Choose βmainβ branch
- Click Save
Your blog will be available at: https://your-username.github.io/your-repo-name
5. Enable Comments (Optional but Recommended)
- Enable Discussions in your GitHub repository:
- Go to Settings β General
- Scroll to βFeaturesβ section
- Check βDiscussionsβ
- Configure Giscus:
- Visit giscus.app
- Enter your repository details
- Copy the generated configuration
- Update
_config.yml
:
giscus: repo: "your-username/your-repo-name" repo_id: "R_kgDOxxxxxxx" # from giscus.app category: "General" category_id: "DIC_kwDOxxxxxxx" # from giscus.app
π Writing Your First Post
-
Create a new file in
_posts/
with format:YYYY-MM-DD-title.md
- Add front matter:
--- layout: post title: "Your Post Title" date: 2025-01-30 10:00:00 +0530 tags: [tag1, tag2, tag3] --- Your post content here...
- Write in Markdown - Jekyll supports full Markdown syntax
π¨ Customization Options
Adding New Pages
- Create
.md
files in root directory - Add to navigation by updating
header_pages
in_config.yml
Styling
- Override theme styles in
_sass/
directory - Add custom CSS to layout files
- Modify existing layouts in
_layouts/
Features
- Dark Mode: Automatic based on system preference
- Fast Loading: Minimal CSS and optimized assets
- SEO Friendly: Proper meta tags and structured data
- RSS Feed: Automatic feed generation at
/feed.xml
π§ Local Development
Prerequisites
- Ruby (2.7 or higher)
- Bundler gem
Setup
# Install dependencies
bundle install
# Start local server
bundle exec jekyll serve
# Visit your blog
open http://localhost:4000
Development Tips
- Changes auto-reload (except
_config.yml
) - Drafts go in
_drafts/
folder - Use
--drafts
flag to preview drafts locally
π File Structure Overview
βββ _config.yml # Main configuration
βββ _posts/ # Blog posts
β βββ 2025-01-15-my-coding-journey.md
β βββ 2025-01-20-setting-up-development-environment.md
β βββ 2025-01-25-understanding-git-basics.md
β βββ 2025-05-31-welcome-to-jekyll.markdown
βββ _layouts/ # Custom layouts
β βββ home.html # Homepage layout
β βββ post.html # Blog post layout
βββ _includes/ # Reusable components
β βββ giscus_comments.html # Comments component
βββ .github/workflows/ # GitHub Actions
β βββ jekyll.yml # Auto-deployment
βββ tags.md # Tags page
βββ about.markdown # About page
βββ index.markdown # Homepage
βββ Gemfile # Ruby dependencies
βββ README.md # Documentation
π Deployment
Automatic Deployment
- GitHub Actions workflow is configured
- Pushes to
main
branch trigger automatic deployment - No manual intervention required
Manual Deployment
If you prefer manual deployment:
- Disable GitHub Actions workflow
- Use GitHub Pages source: βDeploy from a branchβ
- Push to
main
branch
π― Next Steps
- Write your first post - Replace sample posts with your content
- Customize the about page - Make it personal
- Set up comments - Enable community engagement
- Share your blog - Start building your audience
- Regular posting - Consistency is key to growing readership
π Troubleshooting
Common Issues
Blog not loading on GitHub Pages:
- Check repository settings β Pages
- Ensure
main
branch is selected - Wait 5-10 minutes for deployment
Comments not working:
- Verify Discussions are enabled
- Double-check Giscus configuration
- Ensure repository is public
Local development issues:
- Run
bundle install
after any Gemfile changes - Restart server after
_config.yml
changes - Check Ruby version compatibility
Getting Help
π Growing Your Blog
Content Strategy
- Write consistently (weekly/bi-weekly)
- Focus on your expertise areas
- Engage with your audience through comments
- Share posts on social media
SEO Tips
- Use descriptive titles
- Add relevant tags
- Write meta descriptions
- Include internal links
Community Building
- Respond to comments promptly
- Engage with other developersβ blogs
- Share valuable, actionable content
- Be authentic and personal
Congratulations! π Your minimalist blog is ready to go. Start writing and sharing your knowledge with the world!
Need help? Feel free to open an issue in your repository or reach out to the community.