You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 9, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+11-64Lines changed: 11 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,18 @@
1
1

[](https://nextjs.org/)
5
4
6
-
Next.js blogging template for Netlify is a boilerplate for building blogs with only Netlify stacks.
5
+
Next.js blogging template for Vercel is a boilerplate for building blogs with only Vercel stacks.
7
6
8
-
There are some boilerplate or tutorials for the combination of Next.js and Netlify on GitHub. These resources have documentation and good tutorial to get started Next.js and Netlify quickly, but they are too simple to build blogs with standard features like tagging.
7
+
There are some boilerplate or tutorials for the combination of Next.js and Vercel on GitHub. These resources have documentation and good tutorial to get started Next.js and Vercel quickly, but they are too simple to build blogs with standard features like tagging.
9
8
10
-
Next.js blogging template for Netlify has already implemented these standard features for building blogs with only using Next.js and Netlify stacks.
9
+
Next.js blogging template for Vercel has already implemented these standard features for building blogs with only using Next.js and Vercel stacks.
11
10
12
11
## Demo
13
12
14
13
Deploy on your environment by clicking here:
15
14
16
-
[Next.js blog template for Vercel](https://static-cms-next.netlify.app/)
15
+
[Next.js blog template for Vercel](https://static-cms-next-vercel-template.vercel.app/)
17
16
18
17
## Features
19
18
@@ -28,7 +27,7 @@ Deploy on your environment by clicking here:
28
27
29
28
-[TypeScript](https://www.typescriptlang.org/)
30
29
-[Next.js](https://nextjs.org/)
31
-
-[Netlify](https://www.netlify.com/)
30
+
-[Vercel](https://vercel.com/)
32
31
-[MDX](https://mdxjs.com/)
33
32
34
33
## Getting started
@@ -37,72 +36,20 @@ To create your blog using the template, open your terminal, `cd` into the direct
After that, set up your project as following the Netlify blog:
42
+
After that, set up your project, following the Vercel documentation:
44
43
45
-
[A Step-by-Step Guide: Deploying on Netlify](https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/)
44
+
[Creating & Deploying Your Project](https://vercel.com/docs/concepts/get-started/deploy)
46
45
47
-
##Customization
46
+
### Static CMS Config
48
47
49
-
This template is just a template and a boilerplate in which users can customize anything after the project was cloned and started.
50
-
The following instructions introduce common customization points like adding new metadata or applying a new design theme.
51
-
52
-
### Styling pages by a customized theme
53
-
54
-
All source codes related to the blog are under [components](/src/components) and [pages](/src/pages) directory.
55
-
You can modify it freely if you want to apply your design theme.
56
-
All components use [styled-jsx](https://github.com/vercel/styled-jsx) and [css-modules](https://github.com/css-modules/css-modules) to define their styles, but you can choose any styling libraries for designing your theme.
57
-
58
-
The directory tree containing the blog source code are described below:
59
-
60
-
```
61
-
meta: yaml files defining metadata like authors or tags
62
-
public: images, favicons and other static assets
63
-
src
64
-
├── assets: other assets using inside of components
65
-
├── components: pieces of components consisting of pages
66
-
├── content: mdx files for each post page
67
-
├── lib: project libraries like data fetching or pagination
68
-
└── pages: page components managing by Next.js
69
-
```
70
-
71
-
### Organizing content by categories
72
-
73
-
The category metadata that associates with content have the same relationship with the authors' one.
74
-
Then reference these implementations for adding new metadata:
75
-
76
-
-[public/admin/config.yml](/public/admin/config.yml#L51): author metadata definition for Static CMS
77
-
-[src/lib/authors.tsx](/src/lib/authors.ts): fetches metadata and defines utility functions for components
78
-
-[meta/authors.yml](/src/meta/authors.yml): author content managed by Static CMS
79
-
-[src/components/PostLayout.tsx](/src/components/PostLayout.tsx): displays author content for each page
80
-
81
-
You understood they have four steps to add the category metadata on your project after you read the above source codes:
82
-
83
-
1. Define the category metadata on the above Static CMS config file
84
-
2. Create an empty file named with `categories.yml` under [meta](/src/meta/) directory
85
-
3. Create a new module for fetching category metadata
86
-
4. Display the category metadata on [src/components/PostLayout.tsx](/src/components/PostLayout.tsx#L75) or other components you want
87
-
88
-
It is all you have to do. After that, you can access Static CMS and create new categories at any time.
89
-
90
-
### Locale settings for Static CMS
91
-
92
-
Modify [config.yml](/public/admin/config.yml) and
93
-
[index.html](/public/admin/index.html) under [public/admin](/public/admin/) directory
0 commit comments