Skip to content

Commit

Permalink
Merge pull request #19 from odhyp/feature/orion
Browse files Browse the repository at this point in the history
New theme: Orion
  • Loading branch information
odhyp authored Feb 11, 2025
2 parents 0b73e05 + f5e76d9 commit cea65f2
Show file tree
Hide file tree
Showing 37 changed files with 818 additions and 260 deletions.
4 changes: 4 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"MD013": false,
"MD034": false
}
146 changes: 1 addition & 145 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,145 +1 @@
<!-- PROJECT SHIELDS -->

[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]

<!-- PROJECT LOGO -->
<br />
<br />
<div align="center">
<a href="https://github.com/odhyp/hugo-tailwindcss-starter">
<img src="https://upload.wikimedia.org/wikipedia/commons/a/af/Logo_of_Hugo_the_static_website_generator.svg" alt="Logo" width="auto" height="75">
</a>

<h3 align="center">Hugo TailwindCSS Starter</h3>

<p align="center">
A starter project for Hugo and TailwindCSS v4.0
<br />
Ready to deploy in Vercel 🚀
<br />
<a href="https://hugo-tailwindcss-starter.vercel.app/"><strong>View Live »</strong></a>
<br />
<br />
<a href="https://github.com/odhyp/hugo-tailwindcss-starter/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
&middot;
<a href="https://github.com/odhyp/hugo-tailwindcss-starter/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
</p>
<br />
</div>

<!-- ABOUT THE PROJECT -->

## Welcome

This starter project integrates **Hugo** with **TailwindCSS v4.0** and is ready for deployment on **Vercel**.

### Built With

- ![Hugo](https://img.shields.io/badge/Hugo-FF4088?style=for-the-badge&logo=hugo&logoColor=white)
- ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
- ![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)

### Features

- Integration of Hugo and TailwindCSS v4.0
- Easy deployment with Vercel
- Starter templates for rapid development

<!-- GETTING STARTED -->

## Installation

Ensure you have the following installed:

- [Hugo](https://gohugo.io/installation/) (Extended Edition - at least v0.136.x)
- [Node.js](https://nodejs.org/en/download) (at least v18.x)
- [Vercel Account](https://vercel.com/signup) (optional for deployment)

To get a local copy up and running, follow these steps:

1. Clone the repository

```bash
git clone https://github.com/odhyp/hugo-tailwindcss-starter.git
```

2. Navigate to the project directory

```bash
cd hugo-tailwindcss-starter
```

3. Install the Node.js dependencies

```bash
npm install
```

4. Run the development server

```bash
npm run dev
```

5. When development is complete, build the optimized Hugo site

```bash
npm run build
```

<!-- ROADMAP -->

## Roadmap

- No planned updates at the moment. Feel free to suggest improvements!

See the [open issues](https://github.com/odhyp/hugo-tailwindcss-starter/issues) for a full list of proposed features (and known issues).

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/YourFeature`)
3. Commit your Changes (`git commit -m 'Add some YourFeature'`)
4. Push to the Branch (`git push origin feature/YourFeature`)
5. Open a Pull Request

### Top contributors

<a href="https://github.com/odhyp/hugo-tailwindcss-starter/graphs/contributors">
<img src="https://contrib.rocks/image?repo=odhyp/hugo-tailwindcss-starter" alt="contrib.rocks image" />
</a>

<!-- LICENSE -->

## License

Distributed under the MIT License. See [`LICENSE`](https://github.com/odhyp/hugo-tailwindcss-starter/blob/master/LICENSE) for more information.

<!-- ACKNOWLEDGMENTS -->

## Acknowledgements

- [Othneil Drew](https://github.com/othneildrew) for the [README.md Template](https://github.com/othneildrew/Best-README-Template)
- [Alexandre Sanlim](https://github.com/alexandresanlim) for the [README.md badges](https://github.com/alexandresanlim/Badges4-README.md-Profile)
- [Cover image](https://upload.wikimedia.org/wikipedia/commons/a/af/Logo_of_Hugo_the_static_website_generator.svg)

<!-- MARKDOWN LINKS & IMAGES -->

[contributors-shield]: https://img.shields.io/github/contributors/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[contributors-url]: https://github.com/odhyp/hugo-tailwindcss-starter/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[forks-url]: https://github.com/odhyp/hugo-tailwindcss-starter/network/members
[stars-shield]: https://img.shields.io/github/stars/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[stars-url]: https://github.com/odhyp/hugo-tailwindcss-starter/stargazers
[issues-shield]: https://img.shields.io/github/issues/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[issues-url]: https://github.com/odhyp/hugo-tailwindcss-starter/issues
# Orion
25 changes: 25 additions & 0 deletions archetypes/blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{{- $removeDate := substr .Name 11 -}}
{{- $pageTitle := replace $removeDate "-" " " | title -}}
{{- $pageSlug := $removeDate -}}

+++
draft = false
title = "{{ $pageTitle }}"
slug = "{{ $pageSlug }}"
date = {{ now.Format "2006-01-02" }}
tags = ["tag1", "tag2", "tag3"]
+++

<!-- A quick introduction/opening -->

## Main Content

<!-- Write the main content here -->

## Conclusion

<!-- Write the conclusion here -->

### References

<!-- List any references or further readings here -->
36 changes: 36 additions & 0 deletions archetypes/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{{- $removeDate := substr .Name 11 -}}
{{- $pageTitle := replace $removeDate "-" " " | title -}}
{{- $pageSlug := $removeDate -}}

+++
draft = false
featured = false
title = "{{ $pageTitle }}"
slug = "{{ $pageSlug }}"
date = {{ now.Format "2006-01-02" }}
categories = ["categories1", "categories2", "categories3"]
description = "Write a short description of the project here"
cover = "Cover image URL here"
+++

<!-- Provide an overview of the project -->

## Features

<!-- List and describe the features of the project -->

## Installation

<!-- Provide instructions on how to install and use the project -->

## Usage

<!-- Provide usage examples and instructions -->

## Contributing

<!-- Explain how others can contribute to the project -->

## License

<!-- Include licensing information -->
68 changes: 60 additions & 8 deletions assets/css/styles.css
Original file line number Diff line number Diff line change
@@ -1,14 +1,66 @@
@import "tailwindcss";

@plugin "@tailwindcss/typography";
@plugin 'tailwind-scrollbar';

@theme {
--color-avocado-100: oklch(0.99 0 0);
--color-avocado-200: oklch(0.98 0.04 113.22);
--color-avocado-300: oklch(0.94 0.11 115.03);
--color-avocado-400: oklch(0.92 0.19 114.08);
--color-avocado-500: oklch(0.84 0.18 117.33);
--color-avocado-600: oklch(0.53 0.12 118.34);
--font-inter: "Inter", serif;
--color-white-prose: oklch(0.872 0.01 258.338);
}

/* Default site */
html {
scroll-behavior: smooth;
scroll-padding-top: 32px;
}

body {
@apply selection:bg-teal-300 selection:text-teal-900;
}

/* Section container */
.site-container {
@apply mx-auto w-full max-w-2xl;
}

/* Prose container */
article {
@apply prose prose-invert prose-img:rounded-lg;
}

/* Code block and Inline-code block */
pre {
@apply scrollbar-thumb-neutral-800 scrollbar-thin scrollbar-track-neutral-900 rounded-lg bg-neutral-900! p-4;
}

code:not(pre > *) {
@apply rounded bg-neutral-800 p-1 select-all;
}

code::before,
code::after {
@apply hidden;
}

/* Table Of Contents */
#TableOfContents a {
@apply text-white-prose font-normal no-underline;
}

#TableOfContents ol,
#TableOfContents li {
@apply m-0 list-none p-0;
}

#TableOfContents ol {
@apply space-y-2!;
}

/* TOC Heading 3 anchor tags */
#TableOfContents li li > a {
@apply ml-4 inline-block font-light;
}

.sample {
@apply text-red-400 italic;
#TableOfContents ol li ol li {
@apply m-0!;
}
66 changes: 65 additions & 1 deletion assets/js/main.js
Original file line number Diff line number Diff line change
@@ -1 +1,65 @@
console.log("Hugo TailwindCSS Starter!");
document.addEventListener("DOMContentLoaded", function () {
let codeBlocks = document.querySelectorAll("pre > code");

if (codeBlocks.length > 0) {
codeBlocks.forEach((code) => {
let pre = code.parentElement;
let wrapper = document.createElement("div");
wrapper.classList.add("relative");

// Move <pre> inside the wrapper
pre.parentNode.insertBefore(wrapper, pre);
wrapper.appendChild(pre);

// Create Copy Button
let copyButton = document.createElement("button");
copyButton.innerText = "Copy";
copyButton.className =
"absolute top-4 right-4 bg-neutral-800 text-white-prose px-2.5 py-1.5 text-xs rounded-md hover:bg-neutral-700 transition-all ease-in-out copy-btn";

// Append button inside wrapper instead of <pre>
wrapper.appendChild(copyButton);

// Copy Functionality
copyButton.addEventListener("click", function () {
let textToCopy = code.textContent.trim();

if (navigator.clipboard && navigator.clipboard.writeText) {
navigator.clipboard
.writeText(textToCopy)
.then(() => {
copyButton.innerText = "Copied!";
setTimeout(() => (copyButton.innerText = "Copy"), 1500);
})
.catch((err) => {
console.error("Copy failed", err);
fallbackCopy(textToCopy, copyButton);
});
} else {
fallbackCopy(textToCopy, copyButton);
}
});

function fallbackCopy(text, button) {
let textArea = document.createElement("textarea");
textArea.value = text;
document.body.appendChild(textArea);
textArea.select();

try {
let successful = document.execCommand("copy");
if (successful) {
button.innerText = "Copied!";
setTimeout(() => (button.innerText = "Copy"), 1500);
} else {
console.error("Fallback: Copy command was unsuccessful");
}
} catch (err) {
console.error("Fallback: Unable to copy", err);
}

document.body.removeChild(textArea);
}
});
}
});
6 changes: 6 additions & 0 deletions content/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "About"
layout = "about"
+++

# About
8 changes: 8 additions & 0 deletions content/blog/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Blog"
layout = "blog"
+++

# Blog

I started this blog as a way to keep track of what I’ve learned over the years, so I can easily revisit and build on that knowledge in the future.
8 changes: 8 additions & 0 deletions content/project/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Projects"
layout = "project"
+++

# Projects

This page highlights a curated selection of projects that demonstrate my expertise in coding, problem-solving, and developing efficient solutions. From automation tools to interactive web applications, these projects showcase my growth and technical proficiency.
Empty file removed data/.gitkeep
Empty file.
Loading

0 comments on commit cea65f2

Please sign in to comment.