my-jekyll-site/my-jekyll-site/README.md

My Jekyll Site

This is a static site built using Jekyll. It includes a simple structure with headers and footers, and is designed to showcase blog posts.

Project Structure

• _includes/: Contains reusable HTML snippets for the header and footer.

  • header.html: The header structure of the site.
  • footer.html: The footer structure of the site.

• _layouts/: Contains layout templates for the site.

  • default.html: The default layout that includes the header, footer, and content area.
  • post.html: The layout for individual blog posts.

• _posts/: Contains blog posts in markdown format.

  • 2025-01-12-welcome-to-jekyll.md: A sample blog post.

• _config.yml: Configuration file for the Jekyll site, including site title and description.

• index.html: The main landing page of the site.

• about.md: A markdown file containing information about the site or author.

• assets/: Contains static assets like CSS and JavaScript.

  • css/: Contains the main CSS styles.
    • main.css: The main stylesheet for the site.
  • js/: Contains JavaScript files.
    • main.js: The main JavaScript file for interactivity.

Setup Instructions

1. Install Jekyll: Follow the official Jekyll installation guide.
2. Clone the repository:

   git clone <repository-url>
   

3. Navigate to the project directory:

   cd my-jekyll-site
   

4. Install dependencies:

   bundle install
   

5. Serve the site locally:

   bundle exec jekyll serve
   

6. Open your browser: Go to http://localhost:4000 to view your site.

Contributing

Feel free to submit issues or pull requests for improvements or bug fixes.