diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c87c9b3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,36 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.pnpm-debug.log* + +# local env files +.env*.local + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts diff --git a/@types/remark-html.d.ts b/@types/remark-html.d.ts new file mode 100644 index 0000000..e1b76b5 --- /dev/null +++ b/@types/remark-html.d.ts @@ -0,0 +1 @@ +declare module 'remark-html' diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a54468 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# A statically generated blog example using Next.js, Markdown, and TypeScript + +This is the existing [blog-starter](https://github.com/vercel/next.js/tree/canary/examples/blog-starter) plus TypeScript. + +This example showcases Next.js's [Static Generation](https://nextjs.org/docs/basic-features/pages) feature using Markdown files as the data source. + +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. + +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. + +## Demo + +[https://next-blog-starter.vercel.app/](https://next-blog-starter.vercel.app/) + +## Deploy your own + +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) + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/blog-starter&project-name=blog-starter&repository-name=blog-starter) + +### Related examples + +- [WordPress](/examples/cms-wordpress) +- [DatoCMS](/examples/cms-datocms) +- [Sanity](/examples/cms-sanity) +- [TakeShape](/examples/cms-takeshape) +- [Prismic](/examples/cms-prismic) +- [Contentful](/examples/cms-contentful) +- [Strapi](/examples/cms-strapi) +- [Agility CMS](/examples/cms-agilitycms) +- [Cosmic](/examples/cms-cosmic) +- [ButterCMS](/examples/cms-buttercms) +- [Storyblok](/examples/cms-storyblok) +- [GraphCMS](/examples/cms-graphcms) +- [Kontent](/examples/cms-kontent) +- [Umbraco Heartcore](/examples/cms-umbraco-heartcore) +- [Builder.io](/examples/cms-builder-io) +- [TinaCMS](/examples/cms-tina/) +- [Enterspeed](/examples/cms-enterspeed) + +## How to use + +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: + +```bash +npx create-next-app --example blog-starter blog-starter-app +``` + +```bash +yarn create next-app --example blog-starter blog-starter-app +``` + +```bash +pnpm create next-app --example blog-starter blog-starter-app +``` + +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). + +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)). + +# Notes + +`blog-starter` uses [Tailwind CSS](https://tailwindcss.com) [(v3.0)](https://tailwindcss.com/blog/tailwindcss-v3). diff --git a/_posts/dynamic-routing.md b/_posts/dynamic-routing.md new file mode 100644 index 0000000..b6ef7a2 --- /dev/null +++ b/_posts/dynamic-routing.md @@ -0,0 +1,19 @@ +--- +title: 'Dynamic Routing and Static Generation' +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.' +coverImage: '/assets/blog/dynamic-routing/cover.jpg' +date: '2020-03-16T05:35:07.322Z' +author: + name: JJ Kasper + picture: '/assets/blog/authors/jj.jpeg' +ogImage: + url: '/assets/blog/dynamic-routing/cover.jpg' +--- + +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. + +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. + +## Lorem Ipsum + +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. diff --git a/_posts/hello-world.md b/_posts/hello-world.md new file mode 100644 index 0000000..8d85a1d --- /dev/null +++ b/_posts/hello-world.md @@ -0,0 +1,19 @@ +--- +title: 'Learn How to Pre-render Pages Using Static Generation with Next.js' +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.' +coverImage: '/assets/blog/hello-world/cover.jpg' +date: '2020-03-16T05:35:07.322Z' +author: + name: Tim Neutkens + picture: '/assets/blog/authors/tim.jpeg' +ogImage: + url: '/assets/blog/hello-world/cover.jpg' +--- + +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. + +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. + +## Lorem Ipsum + +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. diff --git a/_posts/preview.md b/_posts/preview.md new file mode 100644 index 0000000..3d70ba7 --- /dev/null +++ b/_posts/preview.md @@ -0,0 +1,19 @@ +--- +title: 'Preview Mode for Static Generation' +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.' +coverImage: '/assets/blog/preview/cover.jpg' +date: '2020-03-16T05:35:07.322Z' +author: + name: Joe Haddad + picture: '/assets/blog/authors/joe.jpeg' +ogImage: + url: '/assets/blog/preview/cover.jpg' +--- + +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. + +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. + +## Lorem Ipsum + +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. diff --git a/components/alert.tsx b/components/alert.tsx new file mode 100644 index 0000000..067672f --- /dev/null +++ b/components/alert.tsx @@ -0,0 +1,48 @@ +import Container from './container' +import cn from 'classnames' +import { EXAMPLE_PATH } from '../lib/constants' + +type Props = { + preview?: boolean +} + +const Alert = ({ preview }: Props) => { + return ( +
+ +
+ {preview ? ( + <> + This page is a preview.{' '} + + Click here + {' '} + to exit preview mode. + + ) : ( + <> + The source code for this blog is{' '} + + available on GitHub + + . + + )} +
+ +
+ ) +} + +export default Alert diff --git a/components/avatar.tsx b/components/avatar.tsx new file mode 100644 index 0000000..920d385 --- /dev/null +++ b/components/avatar.tsx @@ -0,0 +1,15 @@ +type Props = { + name: string + picture: string +} + +const Avatar = ({ name, picture }: Props) => { + return ( +
+ {name} +
{name}
+
+ ) +} + +export default Avatar diff --git a/components/container.tsx b/components/container.tsx new file mode 100644 index 0000000..1a1f687 --- /dev/null +++ b/components/container.tsx @@ -0,0 +1,9 @@ +type Props = { + children?: React.ReactNode +} + +const Container = ({ children }: Props) => { + return
{children}
+} + +export default Container diff --git a/components/cover-image.tsx b/components/cover-image.tsx new file mode 100644 index 0000000..4c200c5 --- /dev/null +++ b/components/cover-image.tsx @@ -0,0 +1,36 @@ +import cn from 'classnames' +import Link from 'next/link' +import Image from 'next/image' + +type Props = { + title: string + src: string + slug?: string +} + +const CoverImage = ({ title, src, slug }: Props) => { + const image = ( + {`Cover + ) + return ( +
+ {slug ? ( + + {image} + + ) : ( + image + )} +
+ ) +} + +export default CoverImage diff --git a/components/date-formatter.tsx b/components/date-formatter.tsx new file mode 100644 index 0000000..e827be5 --- /dev/null +++ b/components/date-formatter.tsx @@ -0,0 +1,12 @@ +import { parseISO, format } from 'date-fns' + +type Props = { + dateString: string +} + +const DateFormatter = ({ dateString }: Props) => { + const date = parseISO(dateString) + return +} + +export default DateFormatter diff --git a/components/footer.tsx b/components/footer.tsx new file mode 100644 index 0000000..d2bcba3 --- /dev/null +++ b/components/footer.tsx @@ -0,0 +1,32 @@ +import Container from './container' +import { EXAMPLE_PATH } from '../lib/constants' + +const Footer = () => { + return ( + + ) +} + +export default Footer diff --git a/components/header.tsx b/components/header.tsx new file mode 100644 index 0000000..6ecbe1a --- /dev/null +++ b/components/header.tsx @@ -0,0 +1,14 @@ +import Link from 'next/link' + +const Header = () => { + return ( +

+ + Blog + + . +

+ ) +} + +export default Header diff --git a/components/hero-post.tsx b/components/hero-post.tsx new file mode 100644 index 0000000..6774fac --- /dev/null +++ b/components/hero-post.tsx @@ -0,0 +1,53 @@ +import Avatar from './avatar' +import DateFormatter from './date-formatter' +import CoverImage from './cover-image' +import Link from 'next/link' +import type Author from '../interfaces/author' + +type Props = { + title: string + coverImage: string + date: string + excerpt: string + author: Author + slug: string +} + +const HeroPost = ({ + title, + coverImage, + date, + excerpt, + author, + slug, +}: Props) => { + return ( +
+
+ +
+
+
+

+ + {title} + +

+
+ +
+
+
+

{excerpt}

+ +
+
+
+ ) +} + +export default HeroPost diff --git a/components/intro.tsx b/components/intro.tsx new file mode 100644 index 0000000..d41e6fb --- /dev/null +++ b/components/intro.tsx @@ -0,0 +1,23 @@ +import { CMS_NAME } from '../lib/constants' + +const Intro = () => { + return ( +
+

+ Blog. +

+

+ A statically generated blog example using{' '} + + Next.js + {' '} + and {CMS_NAME}. +

+
+ ) +} + +export default Intro diff --git a/components/layout.tsx b/components/layout.tsx new file mode 100644 index 0000000..9cd23e5 --- /dev/null +++ b/components/layout.tsx @@ -0,0 +1,23 @@ +import Alert from './alert' +import Footer from './footer' +import Meta from './meta' + +type Props = { + preview?: boolean + children: React.ReactNode +} + +const Layout = ({ preview, children }: Props) => { + return ( + <> + +
+ +
{children}
+
+