Skip to content

Commit d3d9618

Browse files
authored
Update README.md
1 parent d14364c commit d3d9618

File tree

1 file changed

+49
-53
lines changed

1 file changed

+49
-53
lines changed

README.md

Lines changed: 49 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# Blog
1+
# 📰 Blog
22

3-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/frankfulness/blog)
3+
<img width="680" alt="Sample" src="https://github.com/user-attachments/assets/fb38b2c9-8f4c-4bd7-9b56-ef92fcb56b91" />
44

5-
This is a [Next.js](https://nextjs.org/), [Tailwind CSS](https://tailwindcss.com/) blog.
6-
Next App directory with [React Server Component](https://nextjs.org/docs/getting-started/react-essentials#server-components) and uses [Contentlayer](https://www.contentlayer.dev/) to manage markdown content.
7-
8-
## Features
5+
## 🏎️ Features
96

107
- Next.js with Typescript
118
- [Contentlayer](https://www.contentlayer.dev/) to manage content logic
@@ -35,7 +32,48 @@ Next App directory with [React Server Component](https://nextjs.org/docs/getting
3532
- Preconfigured security headers
3633
- SEO friendly with RSS feed, sitemaps and more!
3734

38-
## Sample posts
35+
## 🗞️ Posts
36+
37+
Content is modelled using [Contentlayer](https://www.contentlayer.dev/), define content schema and use it to generate typed content objects. See [Contentlayer documentation](https://www.contentlayer.dev/docs/getting-started) for more information.
38+
39+
Frontmatter follows [Hugo's standards](https://gohugo.io/content-management/front-matter/).
40+
41+
Showcase for projects - hero image specs: (16 x 9 - 1920 x 1080)
42+
43+
Please refer to `contentlayer.config.ts` for an up to date list of supported fields. The following fields are supported:
44+
45+
```
46+
title (required)
47+
date (required)
48+
tags (optional)
49+
lastmod (optional)
50+
draft (optional)
51+
summary (optional)
52+
images (optional)
53+
authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified)
54+
layout (optional list which should correspond to the file names in `data/layouts`)
55+
canonicalUrl (optional, canonical url for the post for SEO)
56+
```
57+
58+
Here's an example of a post's frontmatter:
59+
60+
```
61+
---
62+
title: 'Starter Blog'
63+
date: '2025-01-20'
64+
lastmod: '2021-01-18'
65+
tags: ['next-js', 'tailwind', 'guide']
66+
draft: false
67+
summary: 'A performant Stsarter Blog.'
68+
images: ['/static/images/blog-pic.jpg', '/static/images/blog-pic-2.jpg']
69+
authors: ['default', 'sparrowhawk']
70+
layout: PostLayout
71+
canonicalUrl: https://frankcarv.com/blog/
72+
---
73+
```
74+
75+
76+
## 📯 Sample posts
3977

4078
- [A markdown guide](https://tailwind-nextjs-starter-blog.vercel.app/blog/github-markdown-guide)
4179
- [Learn more about images in Next.js](https://tailwind-nextjs-starter-blog.vercel.app/blog/guide-to-using-images-in-nextjs)
@@ -44,7 +82,7 @@ Next App directory with [React Server Component](https://nextjs.org/docs/getting
4482
- [Example of long prose](https://tailwind-nextjs-starter-blog.vercel.app/blog/the-time-machine)
4583
- [Example of Nested Route Post](https://tailwind-nextjs-starter-blog.vercel.app/blog/nested-route/introducing-multi-part-posts-with-nested-routing)
4684

47-
## Steps:
85+
## 🪜 Steps:
4886

4987
1. Personalized `siteMetadata.js` (site related information)
5088
2. Modify the content security policy in `next.config.js` to use
@@ -55,13 +93,13 @@ Next App directory with [React Server Component](https://nextjs.org/docs/getting
5593
6. Added a blog post
5694
7. Deployed on Vercel
5795

58-
## Development
96+
## 👨🏻‍💻 Development
5997

6098
devcontainer runs and opens [http://localhost:3000](http://localhost:3000)
6199

62100
Edit the layout in `app` or content in `data`. With live reloading, the pages auto-updates as you edit them.
63101

64-
## Extend / Customize
102+
## 🎨 Extend / Customize
65103

66104
`data/siteMetadata.js` - contains most of the site related information which should be modified for a user's need.
67105

@@ -94,50 +132,8 @@ Edit the layout in `app` or content in `data`. With live reloading, the pages au
94132

95133
`next.config.js` - configuration related to Next.js. You need to adapt the Content Security Policy if you want to load scripts, images etc. from other domains.
96134

97-
## Post
98-
99-
Content is modelled using [Contentlayer](https://www.contentlayer.dev/), define content schema and use it to generate typed content objects. See [Contentlayer documentation](https://www.contentlayer.dev/docs/getting-started) for more information.
100-
101-
### Frontmatter
102-
103-
Frontmatter follows [Hugo's standards](https://gohugo.io/content-management/front-matter/).
104-
105-
Please refer to `contentlayer.config.ts` for an up to date list of supported fields. The following fields are supported:
106-
107-
```
108-
title (required)
109-
date (required)
110-
tags (optional)
111-
lastmod (optional)
112-
draft (optional)
113-
summary (optional)
114-
images (optional)
115-
authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified)
116-
layout (optional list which should correspond to the file names in `data/layouts`)
117-
canonicalUrl (optional, canonical url for the post for SEO)
118-
```
119-
120-
Here's an example of a post's frontmatter:
121-
122-
```
123-
---
124-
title: 'Starter Blog'
125-
date: '2025-01-20'
126-
lastmod: '2021-01-18'
127-
tags: ['next-js', 'tailwind', 'guide']
128-
draft: false
129-
summary: 'A performant Stsarter Blog.'
130-
images: ['/static/images/blog-pic.jpg', '/static/images/blog-pic-2.jpg']
131-
authors: ['default', 'sparrowhawk']
132-
layout: PostLayout
133-
canonicalUrl: https://frankcarv.com/blog/
134-
---
135-
```
136-
137-
## Deploy
135+
## 👨🏻‍🚀 Deploy
138136

139137
### Vercel
140138

141139
The easiest way to deploy is on [Vercel](https://vercel.com). The [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
142-
143-
Showcase projects with a hero image (16 x 9 - 1920 x 1080)

0 commit comments

Comments
 (0)