Skip to content

Commit ea4b649

Browse files
shashankboosivicb
authored andcommitted
Add the vercel blog-starter example
Created using `pnpm create next-app --example blog-starter vercel-blog-starter`
1 parent e7311df commit ea4b649

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1881
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
.yarn/install-state.gz
8+
9+
# testing
10+
/coverage
11+
12+
# next.js
13+
/.next/
14+
/out/
15+
16+
# production
17+
/build
18+
19+
# misc
20+
.DS_Store
21+
*.pem
22+
23+
# debug
24+
npm-debug.log*
25+
yarn-debug.log*
26+
yarn-error.log*
27+
28+
# local env files
29+
.env*.local
30+
31+
# vercel
32+
.vercel
33+
34+
# typescript
35+
*.tsbuildinfo
36+
next-env.d.ts
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# A statically generated blog example using Next.js, Markdown, and TypeScript
2+
3+
This is the existing [blog-starter](https://github.com/vercel/next.js/tree/canary/examples/blog-starter) plus TypeScript.
4+
5+
This example showcases Next.js's [Static Generation](https://nextjs.org/docs/app/building-your-application/routing/layouts-and-templates) feature using Markdown files as the data source.
6+
7+
The blog posts are stored in `/_posts` as Markdown files with front matter support. Adding a new Markdown file in there will create a new blog post.
8+
9+
To create the blog posts we use [`remark`](https://github.com/remarkjs/remark) and [`remark-html`](https://github.com/remarkjs/remark-html) to convert the Markdown files into an HTML string, and then send it down as a prop to the page. The metadata of every post is handled by [`gray-matter`](https://github.com/jonschlinkert/gray-matter) and also sent in props to the page.
10+
11+
## Demo
12+
13+
[https://next-blog-starter.vercel.app/](https://next-blog-starter.vercel.app/)
14+
15+
## Deploy your own
16+
17+
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/blog-starter)
18+
19+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/blog-starter&project-name=blog-starter&repository-name=blog-starter)
20+
21+
### Related examples
22+
23+
- [WordPress](/examples/cms-wordpress)
24+
- [DatoCMS](/examples/cms-datocms)
25+
- [Sanity](/examples/cms-sanity)
26+
- [TakeShape](/examples/cms-takeshape)
27+
- [Prismic](/examples/cms-prismic)
28+
- [Contentful](/examples/cms-contentful)
29+
- [Strapi](/examples/cms-strapi)
30+
- [Agility CMS](/examples/cms-agilitycms)
31+
- [Cosmic](/examples/cms-cosmic)
32+
- [ButterCMS](/examples/cms-buttercms)
33+
- [Storyblok](/examples/cms-storyblok)
34+
- [GraphCMS](/examples/cms-graphcms)
35+
- [Kontent](/examples/cms-kontent)
36+
- [Umbraco Heartcore](/examples/cms-umbraco-heartcore)
37+
- [Builder.io](/examples/cms-builder-io)
38+
- [TinaCMS](/examples/cms-tina/)
39+
- [Enterspeed](/examples/cms-enterspeed)
40+
41+
## How to use
42+
43+
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
44+
45+
```bash
46+
npx create-next-app --example blog-starter blog-starter-app
47+
```
48+
49+
```bash
50+
yarn create next-app --example blog-starter blog-starter-app
51+
```
52+
53+
```bash
54+
pnpm create next-app --example blog-starter blog-starter-app
55+
```
56+
57+
Your blog should be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions).
58+
59+
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
60+
61+
# Notes
62+
63+
`blog-starter` uses [Tailwind CSS](https://tailwindcss.com) [(v3.0)](https://tailwindcss.com/blog/tailwindcss-v3).
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Dynamic Routing and Static Generation"
3+
excerpt: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Praesent elementum facilisis leo vel fringilla est ullamcorper eget. At imperdiet dui accumsan sit amet nulla facilities morbi tempus."
4+
coverImage: "/assets/blog/dynamic-routing/cover.jpg"
5+
date: "2020-03-16T05:35:07.322Z"
6+
author:
7+
name: JJ Kasper
8+
picture: "/assets/blog/authors/jj.jpeg"
9+
ogImage:
10+
url: "/assets/blog/dynamic-routing/cover.jpg"
11+
---
12+
13+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Praesent elementum facilisis leo vel fringilla est ullamcorper eget. At imperdiet dui accumsan sit amet nulla facilities morbi tempus. Praesent elementum facilisis leo vel fringilla. Congue mauris rhoncus aenean vel. Egestas sed tempus urna et pharetra pharetra massa massa ultricies.
14+
15+
Venenatis cras sed felis eget velit. Consectetur libero id faucibus nisl tincidunt. Gravida in fermentum et sollicitudin ac orci phasellus egestas tellus. Volutpat consequat mauris nunc congue nisi vitae. Id aliquet risus feugiat in ante metus dictum at tempor. Sed blandit libero volutpat sed cras. Sed odio morbi quis commodo odio aenean sed adipiscing. Velit euismod in pellentesque massa placerat. Mi bibendum neque egestas congue quisque egestas diam in arcu. Nisi lacus sed viverra tellus in. Nibh cras pulvinar mattis nunc sed. Luctus accumsan tortor posuere ac ut consequat semper viverra. Fringilla ut morbi tincidunt augue interdum velit euismod.
16+
17+
## Lorem Ipsum
18+
19+
Tristique senectus et netus et malesuada fames ac turpis. Ridiculous mus mauris vitae ultricies leo integer malesuada nunc vel. In mollis nunc sed id semper. Egestas tellus rutrum tellus pellentesque. Phasellus vestibulum lorem sed risus ultricies tristique nulla. Quis blandit turpis cursus in hac habitasse platea dictumst quisque. Eros donec ac odio tempor orci dapibus ultrices. Aliquam sem et tortor consequat id porta nibh. Adipiscing elit duis tristique sollicitudin nibh sit amet commodo nulla. Diam vulputate ut pharetra sit amet. Ut tellus elementum sagittis vitae et leo. Arcu non odio euismod lacinia at quis risus sed vulputate.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Learn How to Pre-render Pages Using Static Generation with Next.js"
3+
excerpt: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Praesent elementum facilisis leo vel fringilla est ullamcorper eget. At imperdiet dui accumsan sit amet nulla facilities morbi tempus."
4+
coverImage: "/assets/blog/hello-world/cover.jpg"
5+
date: "2020-03-16T05:35:07.322Z"
6+
author:
7+
name: Tim Neutkens
8+
picture: "/assets/blog/authors/tim.jpeg"
9+
ogImage:
10+
url: "/assets/blog/hello-world/cover.jpg"
11+
---
12+
13+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Praesent elementum facilisis leo vel fringilla est ullamcorper eget. At imperdiet dui accumsan sit amet nulla facilities morbi tempus. Praesent elementum facilisis leo vel fringilla. Congue mauris rhoncus aenean vel. Egestas sed tempus urna et pharetra pharetra massa massa ultricies.
14+
15+
Venenatis cras sed felis eget velit. Consectetur libero id faucibus nisl tincidunt. Gravida in fermentum et sollicitudin ac orci phasellus egestas tellus. Volutpat consequat mauris nunc congue nisi vitae. Id aliquet risus feugiat in ante metus dictum at tempor. Sed blandit libero volutpat sed cras. Sed odio morbi quis commodo odio aenean sed adipiscing. Velit euismod in pellentesque massa placerat. Mi bibendum neque egestas congue quisque egestas diam in arcu. Nisi lacus sed viverra tellus in. Nibh cras pulvinar mattis nunc sed. Luctus accumsan tortor posuere ac ut consequat semper viverra. Fringilla ut morbi tincidunt augue interdum velit euismod.
16+
17+
## Lorem Ipsum
18+
19+
Tristique senectus et netus et malesuada fames ac turpis. Ridiculous mus mauris vitae ultricies leo integer malesuada nunc vel. In mollis nunc sed id semper. Egestas tellus rutrum tellus pellentesque. Phasellus vestibulum lorem sed risus ultricies tristique nulla. Quis blandit turpis cursus in hac habitasse platea dictumst quisque. Eros donec ac odio tempor orci dapibus ultrices. Aliquam sem et tortor consequat id porta nibh. Adipiscing elit duis tristique sollicitudin nibh sit amet commodo nulla. Diam vulputate ut pharetra sit amet. Ut tellus elementum sagittis vitae et leo. Arcu non odio euismod lacinia at quis risus sed vulputate.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Preview Mode for Static Generation"
3+
excerpt: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Praesent elementum facilisis leo vel fringilla est ullamcorper eget. At imperdiet dui accumsan sit amet nulla facilities morbi tempus."
4+
coverImage: "/assets/blog/preview/cover.jpg"
5+
date: "2020-03-16T05:35:07.322Z"
6+
author:
7+
name: Joe Haddad
8+
picture: "/assets/blog/authors/joe.jpeg"
9+
ogImage:
10+
url: "/assets/blog/preview/cover.jpg"
11+
---
12+
13+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Praesent elementum facilisis leo vel fringilla est ullamcorper eget. At imperdiet dui accumsan sit amet nulla facilities morbi tempus. Praesent elementum facilisis leo vel fringilla. Congue mauris rhoncus aenean vel. Egestas sed tempus urna et pharetra pharetra massa massa ultricies.
14+
15+
Venenatis cras sed felis eget velit. Consectetur libero id faucibus nisl tincidunt. Gravida in fermentum et sollicitudin ac orci phasellus egestas tellus. Volutpat consequat mauris nunc congue nisi vitae. Id aliquet risus feugiat in ante metus dictum at tempor. Sed blandit libero volutpat sed cras. Sed odio morbi quis commodo odio aenean sed adipiscing. Velit euismod in pellentesque massa placerat. Mi bibendum neque egestas congue quisque egestas diam in arcu. Nisi lacus sed viverra tellus in. Nibh cras pulvinar mattis nunc sed. Luctus accumsan tortor posuere ac ut consequat semper viverra. Fringilla ut morbi tincidunt augue interdum velit euismod.
16+
17+
## Lorem Ipsum
18+
19+
Tristique senectus et netus et malesuada fames ac turpis. Ridiculous mus mauris vitae ultricies leo integer malesuada nunc vel. In mollis nunc sed id semper. Egestas tellus rutrum tellus pellentesque. Phasellus vestibulum lorem sed risus ultricies tristique nulla. Quis blandit turpis cursus in hac habitasse platea dictumst quisque. Eros donec ac odio tempor orci dapibus ultrices. Aliquam sem et tortor consequat id porta nibh. Adipiscing elit duis tristique sollicitudin nibh sit amet commodo nulla. Diam vulputate ut pharetra sit amet. Ut tellus elementum sagittis vitae et leo. Arcu non odio euismod lacinia at quis risus sed vulputate.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"private": true,
3+
"scripts": {
4+
"dev": "next",
5+
"build": "next build",
6+
"start": "next start"
7+
},
8+
"dependencies": {
9+
"classnames": "^2.5.1",
10+
"date-fns": "^3.6.0",
11+
"gray-matter": "^4.0.3",
12+
"next": "latest",
13+
"react": "^18.3.1",
14+
"react-dom": "^18.3.1",
15+
"remark": "^15.0.1",
16+
"remark-html": "^16.0.1"
17+
},
18+
"devDependencies": {
19+
"@types/node": "^20.14.8",
20+
"@types/react": "^18.3.3",
21+
"@types/react-dom": "^18.3.0",
22+
"autoprefixer": "^10.4.19",
23+
"postcss": "^8.4.38",
24+
"tailwindcss": "^3.4.4",
25+
"typescript": "^5.5.2"
26+
}
27+
}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module.exports = {
2+
plugins: {
3+
tailwindcss: {},
4+
autoprefixer: {},
5+
},
6+
};
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<browserconfig>
3+
<msapplication>
4+
<tile>
5+
<square150x150logo src="/favicons/mstile-150x150.png"/>
6+
<TileColor>#000000</TileColor>
7+
</tile>
8+
</msapplication>
9+
</browserconfig>
Loading
Loading
Binary file not shown.
Loading
Lines changed: 33 additions & 0 deletions
Loading
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "Next.js",
3+
"short_name": "Next.js",
4+
"icons": [
5+
{
6+
"src": "/favicons/android-chrome-192x192.png",
7+
"sizes": "192x192",
8+
"type": "image/png"
9+
},
10+
{
11+
"src": "/favicons/android-chrome-512x512.png",
12+
"sizes": "512x512",
13+
"type": "image/png"
14+
}
15+
],
16+
"theme_color": "#000000",
17+
"background_color": "#000000",
18+
"display": "standalone"
19+
}
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import Container from "@/app/_components/container";
2+
import { EXAMPLE_PATH } from "@/lib/constants";
3+
import cn from "classnames";
4+
5+
type Props = {
6+
preview?: boolean;
7+
};
8+
9+
const Alert = ({ preview }: Props) => {
10+
return (
11+
<div
12+
className={cn("border-b dark:bg-slate-800", {
13+
"bg-neutral-800 border-neutral-800 text-white": preview,
14+
"bg-neutral-50 border-neutral-200": !preview,
15+
})}
16+
>
17+
<Container>
18+
<div className="py-2 text-center text-sm">
19+
{preview ? (
20+
<>
21+
This page is a preview.{" "}
22+
<a
23+
href="/api/exit-preview"
24+
className="underline hover:text-teal-300 duration-200 transition-colors"
25+
>
26+
Click here
27+
</a>{" "}
28+
to exit preview mode.
29+
</>
30+
) : (
31+
<>
32+
The source code for this blog is{" "}
33+
<a
34+
href={`https://github.com/vercel/next.js/tree/canary/examples/${EXAMPLE_PATH}`}
35+
className="underline hover:text-blue-600 duration-200 transition-colors"
36+
>
37+
available on GitHub
38+
</a>
39+
.
40+
</>
41+
)}
42+
</div>
43+
</Container>
44+
</div>
45+
);
46+
};
47+
48+
export default Alert;
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
type Props = {
2+
name: string;
3+
picture: string;
4+
};
5+
6+
const Avatar = ({ name, picture }: Props) => {
7+
return (
8+
<div className="flex items-center">
9+
<img src={picture} className="w-12 h-12 rounded-full mr-4" alt={name} />
10+
<div className="text-xl font-bold">{name}</div>
11+
</div>
12+
);
13+
};
14+
15+
export default Avatar;
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
type Props = {
2+
children?: React.ReactNode;
3+
};
4+
5+
const Container = ({ children }: Props) => {
6+
return <div className="container mx-auto px-5">{children}</div>;
7+
};
8+
9+
export default Container;
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import cn from "classnames";
2+
import Link from "next/link";
3+
import Image from "next/image";
4+
5+
type Props = {
6+
title: string;
7+
src: string;
8+
slug?: string;
9+
};
10+
11+
const CoverImage = ({ title, src, slug }: Props) => {
12+
const image = (
13+
<Image
14+
src={src}
15+
alt={`Cover Image for ${title}`}
16+
className={cn("shadow-sm w-full", {
17+
"hover:shadow-lg transition-shadow duration-200": slug,
18+
})}
19+
width={1300}
20+
height={630}
21+
/>
22+
);
23+
return (
24+
<div className="sm:mx-0">
25+
{slug ? (
26+
<Link href={`/posts/${slug}`} aria-label={title}>
27+
{image}
28+
</Link>
29+
) : (
30+
image
31+
)}
32+
</div>
33+
);
34+
};
35+
36+
export default CoverImage;
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { parseISO, format } from "date-fns";
2+
3+
type Props = {
4+
dateString: string;
5+
};
6+
7+
const DateFormatter = ({ dateString }: Props) => {
8+
const date = parseISO(dateString);
9+
return <time dateTime={dateString}>{format(date, "LLLL d, yyyy")}</time>;
10+
};
11+
12+
export default DateFormatter;

0 commit comments

Comments
 (0)