Skip to content

Commit

Permalink
Add Jekyll theme to README file (#85)
Browse files Browse the repository at this point in the history
---

For more details, open the [Copilot Workspace
session](https://copilot-workspace.githubnext.com/x0lg0n/Code-Contribution?shareId=70ffba5d-4da3-44cc-8590-f5b77047acc1).

## Summary by Sourcery

Add a Jekyll theme to the repository and update the README with
instructions for local setup and site generation.

New Features:
- Introduce a Jekyll theme to the repository, enabling local site
generation and customization.

Documentation:
- Add instructions to the README file for setting up and running the
Jekyll site locally.
  • Loading branch information
x0lg0n authored Nov 1, 2024
2 parents 43a966f + 666fbba commit 918824c
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
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
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
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<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
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>

0 comments on commit 918824c

Please sign in to comment.