An open API service indexing awesome lists of open source software.

https://github.com/c-ehrlich/personal-site

[outdated] Repository for my developer portfolio
https://github.com/c-ehrlich/personal-site

Last synced: 4 months ago
JSON representation

[outdated] Repository for my developer portfolio

Awesome Lists containing this project

README

          

# Personal Site

## What is this?
This is the repository for my homepage / blog / portfolio. It uses Next.js Server Side Generation to create its content from Markdown files. There are many like it, but this one is mine.

## Getting Started

Clone the repository, then install dependencies and start the development server
```bash
yarn
yarn dev
```

## Adding blog posts or projects
Data for each item goes into a Markdown file, which should be saved to `/data//.md`. Images should be saved to anywhere inside the `/public` folder.

Each file must start with the relevant frontmatter, followed by the project or post itself in markdown.

### Example blog post frontmatter
```
---
title: My first blog post
publishedDate: 2022/03/13
tags:
- Hello World
- Another tag
---
```

### Example project frontmatter
```
---
title: Todo list
description: Everyone's favourite project!
publishedDate: 2022/03/13
tags:
- 6502 Assembly
- JQuery
- Duct Tape
image: /img/project/project-screenshot.jpg
github: https://github.com/username/reponame
---
```
Note that you should not include `/public` in the image url.

## Deploy on Vercel

The easiest way to deploy this app is to use the [Vercel Platform](https://vercel.com/new).

Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

## Performance and Accessibility

Performance and Accessibility are important aspects of web design to me. I like using Google's Lighthouse test to measure how I'm doing, but I believe it should not be taken as the only measure. For example, there is a known bug relating to [Image size](https://github.com/GoogleChrome/lighthouse/issues/11631) that currently prevents this website from scoring 100 on Lighthouse. It has no influence on humans using the site, so I don't believe it is worth dealing with.

## Acknowledgements
Markdown blog functionality based on this post by Julia Tan https://bionicjulia.com/blog/setting-up-nextjs-markdown-blog-with-typescript