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.

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

Create next-hendrix.md #517

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
160 changes: 160 additions & 0 deletions content/theme/next-hendrix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
---
title: "Hendrix"
github: https://github.com/marpeand/hendrix
demo: https://hendrix-template.vercel.app/
author: marpeand
date: 2024-12-07
ssg:
- NextJS
cms:
- No CMS
css:
- Tailwind
archetype:
- Blog
- Portfolio
- Personal
description: Personal Blog and Portfolio template build using NextJS & TailwindCSS.
---

<div align="center">
<a href="https://github.com/marpeand/hendrix">
<img src="https://raw.githubusercontent.com/marpeand/hendrix/main/public/logo.png" alt="Logo" width="120" height="120">
</a>
</br>

<h1 align=center> Hendrix Template</h1>
<p align="center">
Personal Blog and Portfolio template build using NextJS & TailwindCSS. :rocket:
<br />
<a href="https://hendrix-template.vercel.app"><strong>(https://hendrix-template.vercel.app/)</strong></a>
</p>
</div>
<br />

| Dark mode | Light mode |
| ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |
| ![Dark mode](https://raw.githubusercontent.com/marpeand/hendrix/main/public/dark-screenshot.png) | ![Light mode](https://raw.githubusercontent.com/marpeand/hendrix/main/public/light-screenshot.png) |

### Key Features

- Great page load speed
- Use [ContentLayer](https://www.contentlayer.dev/) to compile mdx
- Responsive for all devices
- Fast configuration, only edit the `blog.config.js` file
- Math syntax support using [rehypeKatex](https://katex.org/)
- Code support using **rehypePrettyCode**
- RSS feed, sitemap, and robots.txt
- Dark and light themes

# Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

## Installation

1. Clone the repo

```sh
git clone https://github.com/marpeand/hendrix.git
```

2. Install packages

```sh
pnpm install
```

3. Personalize the `blog.config.js` file with your own information

```js
const CONFIG = {
// Site config
title: "Hendrix",
siteDescription: "Blog and portfolio created with Next.js and Tailwind CSS",
baseURL: "https://hendrix-template.vercel.app",
...
...
}
```

4. Write your own blog posts using Markdown in `content/writing` folder. Also, you can add your own projects in `content/projects` folder and notes in `content/notes` folder.
5. Modify the `content/about.mdx` file to update your biography.

## Content and Config

### Post

Every post is crafted using [ContentLayer](https://www.contentlayer.dev/). To ensure compilation, it must adhere to specific required and optional fields, as exemplified below:

```
title (required)
description (optional but recommended)
date (required)
draft (required)
tags (optional)
```

An example:

```
---
title: "Decoding Signal Processing Basics: A Practical Guide"
date: 2023-11-30
description: "An introduction to signal processing concepts and their applications in engineering and everyday life."
draft: false
tags:
- Mathematics
- Signal Processing
- Engineering
---
```

![Post Page](https://raw.githubusercontent.com/marpeand/hendrix/refs/heads/main/public/post-page-screenshot.png)

### Projects

List your personal side projects in the `content/projects` folder, here it's an example of these.

```
title (required)
description (optional but recommended)
date (required)
draft (required)
github (optional)
```

```
---
title: "Gamify Your Life"
description: "A productivity application that turns daily tasks and goals into a gamified experience with levels, achievements, and rewards."
date: 2023-12-15
github: https://github.com/marpeand/gamify-your-life
---
```

### Notes

List your notes in the `content/notes` folder, here it's an example of these.

```
---
title: "Note Title"
date: 2023-12-15
draft: false
---
```

### Static Files

When adding images to your blog post, it's recommended to store them in the `public/static` directory. This ensures accessibility and proper linking. Follow these steps:
To reference an image in your project, use the path starting from the root of the `public` directory.

Example: If your image is in `public/static/my-blog-post/myimage.png`

You can change the favicon in the `app/favicon.ico` file.

# License

By contributing to the project, you agree to license your contributions under the same license as the project itself. See the [LICENSE](LICENSE) file for more information.