Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Jekyll theme to README file #85

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Add Jekyll theme to README file #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,3 +235,41 @@ int main() {
```

Feel free to explore the repository and see more examples in various languages. Happy contributing!

## Jekyll Theme

This repository uses the Jekyll theme `minima`. To run the site locally, follow these steps:

1. **Install Jekyll**: Make sure you have Ruby and Bundler installed. Then install Jekyll with the following command:

```bash
gem install jekyll bundler
```

2. **Clone the repository**: If you haven't already, clone the repository to your local machine:

```bash
git clone https://github.com/your-username/Code-Contribution.git
```

3. **Navigate to the repository directory**:

```bash
cd Code-Contribution
```

4. **Install dependencies**: Install the required dependencies using Bundler:

```bash
bundle install
```

5. **Run the Jekyll site**: Use the following command to build and serve the site locally:

```bash
bundle exec jekyll serve
```

6. **Open your browser**: Open your web browser and go to `http://localhost:4000` to see the site.

For more information on Jekyll, visit the [Jekyll documentation](https://jekyllrb.com/docs/).
4 changes: 4 additions & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
theme: minima
title: Code Contribution
description: A repository for code contributions in various languages.
baseurl: "/Code-Contribution"
3 changes: 3 additions & 0 deletions _includes/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<footer>
<p>&copy; {{ site.time | date: '%Y' }} Code Contribution. All rights reserved.</p>
</footer>
9 changes: 9 additions & 0 deletions _includes/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<header>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Remove redundant header tag to avoid nested header elements

Since this component is included within a header tag in default.html, the outer header tag here should be removed to maintain proper HTML semantics and accessibility.

<div class="site-header">

<nav>
<ul>
<li><a href="{{ site.baseurl }}/">Home</a></li>
<li><a href="{{ site.baseurl }}/about">About</a></li>
<li><a href="{{ site.baseurl }}/contact">Contact</a></li>
</ul>
</nav>
</header>
19 changes: 19 additions & 0 deletions _layouts/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{{ page.title }}</title>
</head>
<body>
<header>
{% include header.html %}
</header>
<main>
{{ content }}
</main>
<footer>
{% include footer.html %}
</footer>
</body>
</html>
Loading