Skip to content

Commit

Permalink
create readme and clean content folder
Browse files Browse the repository at this point in the history
  • Loading branch information
huzmgod committed Sep 30, 2023
1 parent 3225e91 commit 65f6ba1
Show file tree
Hide file tree
Showing 7 changed files with 97 additions and 5 deletions.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<h1 align="center">📖 Code Triarii GH Pages Guide</h1>

<p align="center">
<img src="https://img.shields.io/badge/Platform-GitHub%20Pages-green?style=for-the-badge&logo=github" alt="Platform - GitHub Pages">
<img src="https://img.shields.io/badge/Engine-Hugo-blue?style=for-the-badge&logo=hugo" alt="Engine - Hugo">
<img src="https://img.shields.io/badge/Deployment-GitHub%20Actions-yellowgreen?style=for-the-badge&logo=github-actions" alt="Deployment - GitHub Actions">
</p>

---

## 🚀 Getting Started

### 1️⃣ Clone the Repository

To start, you need to clone the repository to your local machine.

```bash
git clone https://github.com/code-triarii/code-triarii.github.io.git
```

### 2️⃣ Modify the Content

Navigate to the `/content` folder and make your desired changes.

```bash
cd code-triarii.github.io/content
```

⚠️ Please, do not modify `/themes/terminal` folder if you are unsure of what you are doing.

### 3️⃣ Test it Locally
Before deploying, you should always test your changes. Run the Hugo server using the following command:


```bash
hugo serve
```

Visit `localhost:1313` in your browser to see the live changes.

### 4️⃣ Build the Site
Build your site and make sure the docs folder gets updated.

```bash
hugo
```
Check if the docs folder has been changed using:

```bash
git status
```

### 5️⃣ Commit & Push Changes

Once you're satisfied with your changes:

```bash
git add .
git commit -m "Describe your changes here"
git push origin master
```
Wait for GitHub Actions to deploy the page.

### 6️⃣ Visit the Site
Your changes should now be live (it needs a little bit of time to get everything running correctly). Visit `code-triarii.github.io` to see them.
16 changes: 16 additions & 0 deletions content/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@
width: 50px;
height: auto;
}
.right-div {
position: absolute;
right: 5%;
top: 0;
float: right;
max-width: 40vw;
margin: 10px;
}
</style>

<div class="index-content framed">
Expand Down Expand Up @@ -43,6 +51,14 @@ <h1 id="code-triarii" class="post-title">
</span>
</div>
</div>
<!-- <div class="right-div">
<img
src="./cover.jpg"
class="post-cover"
alt="Hello Friend"
title="Cover Image"
/>
</div> -->
<script>
fetch("https://api.github.com/orgs/code-triarii/repos")
.then((response) => response.json())
Expand Down
Binary file added content/cover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions content/readme/_index.html

This file was deleted.

Binary file added docs/cover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,14 @@
width: 50px;
height: auto;
}
.right-div {
position: absolute;
right: 5%;
top: 0;
float: right;
max-width: 40vw;
margin: 10px;
}
</style>

<div class="index-content framed">
Expand Down Expand Up @@ -175,6 +183,14 @@ <h1 id="code-triarii" class="post-title">
</span>
</div>
</div>
<!-- <div class="right-div">
<img
src="./cover.jpg"
class="post-cover"
alt="Hello Friend"
title="Cover Image"
/>
</div> -->
<script>
fetch("https://api.github.com/orgs/code-triarii/repos")
.then((response) => response.json())
Expand Down
2 changes: 0 additions & 2 deletions docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
<loc>https://code-triarii.github.io/about/</loc>
</url><url>
<loc>https://code-triarii.github.io/categories/</loc>
</url><url>
<loc>https://code-triarii.github.io/readme/</loc>
</url><url>
<loc>https://code-triarii.github.io/</loc>
</url><url>
Expand Down

0 comments on commit 65f6ba1

Please sign in to comment.