Skip to content

hkennyv/kennyvh.com

Repository files navigation

netlify build format

kennyvh.com

Overview

My personal site & blog :), made using my NextJS terminal theme port of the popular Terminal Hugo theme.

This repostiory was forked from the NextJS terminal theme port and may contain some changes that aren't present in the upstream like a CMS or changes to certain routes' index pages. However, the majority of the theme remains the same as the upstream.

The live site can be viewed here: https://kennyvh.com

Usage

To get started, you'll need:

Cloning the repository

Clone the repository to your local machine using the following command:

git clone https://github.com/hkennyv/kennyvh.com.git

Install dependencies

Install dependencies using yarn:

yarn install

Running a dev server

You can see all the features the dev server includes here. Use the following command to start the dev server:

yarn dev

Publishing the site

It's highly recommended to use Netlify to host this site due to their excellent support for Next.js (and it's free)!

Deploying static pages (recommended)

You can export your application to static HTML, which can be served without a node.js server required. This is preferred for this site:

yarn build && yarn export

This generates an out/ directory that can be served by any static site page host or CDN.

Deploying with a custom server

To deploy the site, you can use the following build command:

yarn build

This will build the application in the .next/ folder. Then use the following command to start a node.js server that serves both statically generated and server-side generated pages:

yarn start

For more details on deployment, see the Next.js docs.

Keeping up to date with the theme

This site theme is inspired by panr/hugo-theme-terminal. I ported this theme (with permission, of course) to a React/Next.JS theme, hkennyv/next-theme-terminal.

I try my best to keep the NextJS theme in sync with the hugo theme, so the recommended way to keep your theme up to date is to add the theme repository as another remote that you can merge into your site.

Adding a new remote, theme

git remote add theme git@github.com:hkennyv/next-theme-terminal.git

Updating the theme

git pull theme main

NOTE: If you've changed any of the theme files, there may be merge conflicts you will need to resolve to move forward.

License

Copyright © 2019-2020 Radosław Kozieł (@panr) and Kenny Huynh (@hkennyv).

The theme is released under the MIT License. Check the original theme license for additional licensing information.