Skip to content

A blog site for aws notes using jekyll a static site generator and chirpy theme.

License

Notifications You must be signed in to change notification settings

Anky209e/anky209e.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

BloGsmith

A personal notes-taking site built with Jekyll using the Chirpy theme. Hosted at https://anky209e.github.io.

πŸ“ About This Site

This is a static blog/notes platform focused on cloud computing, AWS, and technical documentation. It serves as a personal knowledge base for learning and reference.

  • Theme: Jekyll Chirpy v5.2+
  • Content: Technical notes, AWS tutorials, cloud computing concepts
  • Language: English
  • Deployment: GitHub Pages (automatic)

πŸš€ Quick Start

Prerequisites

Ensure you have the following installed:

  • Ruby 2.7+
  • RubyGems
  • Jekyll
  • Bundler

For detailed installation instructions, see the Jekyll Docs.

Local Development Setup

  1. Clone the repository

    git clone https://github.com/Anky209e/anky209e.github.io.git
    cd anky209e.github.io
  2. Install dependencies

    bundle install
  3. Start the local development server

    bundle exec jekyll serve
  4. View your site Navigate to http://localhost:4000 in your browser.

Alternative Local Development

For development with live reload:

bundle exec jekyll serve --livereload

To build the site locally without serving:

bundle exec jekyll build

πŸ“‚ Project Structure

.
β”œβ”€β”€ _config.yml              # Jekyll configuration
β”œβ”€β”€ _data/                   # Site data files
β”‚   β”œβ”€β”€ locales/            # Translation files
β”‚   β”œβ”€β”€ contact.yml         # Contact information
β”‚   └── share.yml           # Social sharing settings
β”œβ”€β”€ _posts/                  # Blog posts and notes
β”œβ”€β”€ _tabs/                   # Navigation pages
β”œβ”€β”€ _plugins/                # Jekyll plugins
β”œβ”€β”€ assets/                  # Static assets (CSS, JS, images)
β”œβ”€β”€ tools/                   # Deployment and build scripts
β”œβ”€β”€ .github/workflows/       # GitHub Actions workflows
β”œβ”€β”€ Gemfile                  # Ruby dependencies
β”œβ”€β”€ index.html              # Homepage
└── README.md               # This file

✍️ Content Management

Creating New Posts

  1. Create a new file in _posts/ with the naming convention: YYYY-MM-DD-title.md
  2. Add front matter with required fields:
    ---
    title: "Your Post Title"
    date: YYYY-MM-DD HH:MM +/-TTTT
    categories: [Category1, Category2]
    tags: [tag1, tag2, tag3]
    ---

Supported Formats

  • Markdown with GitHub Flavored Markdown
  • HTML embedding
  • Syntax highlighting for code blocks
  • MathJax support for mathematical expressions

πŸ”§ Configuration

Site Settings

Edit _config.yml to customize:

  • Site title and description
  • Author information
  • Social links
  • Theme settings
  • Google Analytics
  • Comments system

Theme Customization

The Chirpy theme supports:

  • Light/dark mode toggle
  • Table of contents
  • PWA features
  • Responsive design
  • Search functionality

For advanced customization options, see the Chirpy Theme Documentation.

πŸš€ Deployment

Automatic Deployment

This site uses GitHub Actions for automatic deployment:

  1. Push changes to the main branch
  2. GitHub Actions automatically builds and deploys to GitHub Pages
  3. Site is live at https://anky209e.github.io

Manual Testing

To test the build locally before pushing:

# Build and test (but don't deploy)
bash tools/deploy.sh --dry-run

Build Process

The deployment script (tools/deploy.sh) performs:

  1. Jekyll site building
  2. HTML validation with html-proofer
  3. Deployment to gh-pages branch
  4. GitHub Pages publication

πŸ§ͺ Development Commands

# Install dependencies
bundle install

# Start development server
bundle exec jekyll serve

# Start with live reload
bundle exec jekyll serve --livereload

# Build site
bundle exec jekyll build

# Test site build
bundle exec html-proofer _site --disable-external --check-html

# Deploy (GitHub Actions only)
bash tools/deploy.sh

πŸ” Available Features

  • Responsive Design: Works on all devices
  • Dark/Light Mode: Toggle between themes
  • Search: Built-in site search
  • Categories & Tags: Organized content structure
  • Table of Contents: Auto-generated for posts
  • Social Sharing: Integrated sharing buttons
  • PWA Support: Progressive Web App features
  • Comments: Configurable comment system
  • Analytics: Google Analytics integration

🌐 Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

πŸ“„ License

This work is published under MIT License.

🀝 Contributing

This is a personal blog, but feel free to:

  • Report issues or typos
  • Suggest improvements
  • Fork for your own use

πŸ“š Additional Resources

πŸ› Troubleshooting

Common Issues

  1. Bundle install fails

    gem install --user-install bundler
    bundle install --path vendor/bundle
  2. Jekyll serve doesn't work

    bundle exec jekyll clean
    bundle exec jekyll serve
  3. Permission denied on deploy.sh

    chmod +x tools/deploy.sh

Getting Help


Built with ❀️ using Jekyll and Chirpy theme

About

A blog site for aws notes using jekyll a static site generator and chirpy theme.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •