├── .gitignore ├── README.md ├── _posts ├── dynamic-routing.md ├── hello-world.md └── preview.md ├── components ├── alert.js ├── avatar.js ├── container.js ├── cover-image.js ├── date-formater.js ├── footer.js ├── header.js ├── hero-post.js ├── intro.js ├── layout.js ├── markdown-styles.module.css ├── meta.js ├── more-stories.js ├── post-body.js ├── post-header.js ├── post-preview.js ├── post-title.js └── section-separator.js ├── lib ├── api.js ├── constants.js └── markdownToHtml.js ├── package.json ├── pages ├── _app.js ├── _document.js ├── index.js └── posts │ └── [slug].js ├── postcss.config.js ├── public ├── assets │ └── blog │ │ ├── authors │ │ ├── jj.jpeg │ │ ├── joe.jpeg │ │ └── tim.jpeg │ │ ├── dynamic-routing │ │ └── cover.jpg │ │ ├── hello-world │ │ └── cover.jpg │ │ └── preview │ │ └── cover.jpg └── favicon │ ├── android-chrome-192x192.png │ ├── android-chrome-512x512.png │ ├── apple-touch-icon.png │ ├── browserconfig.xml │ ├── favicon-16x16.png │ ├── favicon-32x32.png │ ├── favicon.ico │ ├── mstile-150x150.png │ ├── safari-pinned-tab.svg │ └── site.webmanifest ├── styles └── index.css └── tailwind.config.js /.gitignore: -------------------------------------------------------------------------------- 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 | 8 | # testing 9 | /coverage 10 | 11 | # next.js 12 | /.next/ 13 | /out/ 14 | 15 | # production 16 | /build 17 | 18 | # misc 19 | .DS_Store 20 | *.pem 21 | 22 | # debug 23 | npm-debug.log* 24 | yarn-debug.log* 25 | yarn-error.log* 26 | 27 | # local env files 28 | .env.local 29 | .env.development.local 30 | .env.test.local 31 | .env.production.local 32 | 33 | # vercel 34 | .vercel 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A statically generated blog example using Next.js and Markdown 2 | 3 | This example showcases Next.js's [Static Generation](https://nextjs.org/docs/basic-features/pages) feature using markdown files as the data source. 4 | 5 | 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. 6 | 7 | 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. 8 | 9 | ## Demo 10 | 11 | [https://next-blog-starter.now.sh/](https://next-blog-starter.now.sh/) 12 | 13 | ## Deploy your own 14 | 15 | Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example): 16 | 17 | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/blog-starter) 18 | 19 | ### Related examples 20 | 21 | - [WordPress](/examples/cms-wordpress) 22 | - [DatoCMS](/examples/cms-datocms) 23 | - [Sanity](/examples/cms-sanity) 24 | - [TakeShape](/examples/cms-takeshape) 25 | - [Prismic](/examples/cms-prismic) 26 | - [Contentful](/examples/cms-contentful) 27 | - [Strapi](/examples/cms-strapi) 28 | - [Agility CMS](/examples/cms-agilitycms) 29 | - [Cosmic](/examples/cms-cosmic) 30 | - [ButterCMS](/examples/cms-buttercms) 31 | - [Storyblok](/examples/cms-storyblok) 32 | - [GraphCMS](/examples/cms-graphcms) 33 | 34 | ## How to use 35 | 36 | ### Using `create-next-app` 37 | 38 | Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example: 39 | 40 | ```bash 41 | npx create-next-app --example blog-starter blog-starter-app 42 | # or 43 | yarn create next-app --example blog-starter blog-starter-app 44 | ``` 45 | 46 | ### Download manually 47 | 48 | Download the example: 49 | 50 | ```bash 51 | curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/blog-starter 52 | cd blog-starter 53 | ``` 54 | 55 | Install dependencies and run the example: 56 | 57 | ```bash 58 | npm install 59 | npm run dev 60 | 61 | # or 62 | 63 | yarn install 64 | yarn dev 65 | ``` 66 | 67 | 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). 68 | 69 | Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). 70 | 71 | # Notes 72 | 73 | This blog-starter uses [Tailwind CSS](https://tailwindcss.com). To control the generated stylesheet's filesize, this example uses Tailwind CSS' v1.4 [`purge` option](https://tailwindcss.com/docs/controlling-file-size/#removing-unused-css) to remove unused CSS. 74 | -------------------------------------------------------------------------------- /_posts/dynamic-routing.md: -------------------------------------------------------------------------------- 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. 20 | -------------------------------------------------------------------------------- /_posts/hello-world.md: -------------------------------------------------------------------------------- 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. 20 | -------------------------------------------------------------------------------- /_posts/preview.md: -------------------------------------------------------------------------------- 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. 20 | -------------------------------------------------------------------------------- /components/alert.js: -------------------------------------------------------------------------------- 1 | import Container from './container' 2 | import cn from 'classnames' 3 | import { EXAMPLE_PATH } from '../lib/constants' 4 | 5 | export default function Alert({ preview }) { 6 | return ( 7 |
13 | 14 |
15 | {preview ? ( 16 | <> 17 | This is page is a preview.{' '} 18 | 22 | Click here 23 | {' '} 24 | to exit preview mode. 25 | 26 | ) : ( 27 | <> 28 | The source code for this blog is{' '} 29 | 33 | available on GitHub 34 | 35 | . 36 | 37 | )} 38 |
39 |
40 |
41 | ) 42 | } 43 | -------------------------------------------------------------------------------- /components/avatar.js: -------------------------------------------------------------------------------- 1 | export default function Avatar({ name, picture }) { 2 | return ( 3 |
4 | {name} 5 |
{name}
6 |
7 | ) 8 | } 9 | -------------------------------------------------------------------------------- /components/container.js: -------------------------------------------------------------------------------- 1 | export default function Container({ children }) { 2 | return
{children}
3 | } 4 | -------------------------------------------------------------------------------- /components/cover-image.js: -------------------------------------------------------------------------------- 1 | import cn from 'classnames' 2 | import Link from 'next/link' 3 | 4 | export default function CoverImage({ title, src, slug }) { 5 | const image = ( 6 | {`Cover 13 | ) 14 | return ( 15 |
16 | {slug ? ( 17 | 18 | {image} 19 | 20 | ) : ( 21 | image 22 | )} 23 |
24 | ) 25 | } 26 | -------------------------------------------------------------------------------- /components/date-formater.js: -------------------------------------------------------------------------------- 1 | import { parseISO, format } from 'date-fns' 2 | 3 | export default function DateFormater({ dateString }) { 4 | const date = parseISO(dateString) 5 | return 6 | } 7 | -------------------------------------------------------------------------------- /components/footer.js: -------------------------------------------------------------------------------- 1 | import Container from './container' 2 | import { EXAMPLE_PATH } from '../lib/constants' 3 | 4 | export default function Footer() { 5 | return ( 6 | 29 | ) 30 | } 31 | -------------------------------------------------------------------------------- /components/header.js: -------------------------------------------------------------------------------- 1 | import Link from 'next/link' 2 | 3 | export default function Header() { 4 | return ( 5 |

6 | 7 | Blog 8 | 9 | . 10 |

11 | ) 12 | } 13 | -------------------------------------------------------------------------------- /components/hero-post.js: -------------------------------------------------------------------------------- 1 | import Avatar from '../components/avatar' 2 | import DateFormater from '../components/date-formater' 3 | import CoverImage from '../components/cover-image' 4 | import Link from 'next/link' 5 | 6 | export default function HeroPost({ 7 | title, 8 | coverImage, 9 | date, 10 | excerpt, 11 | author, 12 | slug, 13 | }) { 14 | return ( 15 |
16 |
17 | 18 |
19 |
20 |
21 |

22 | 23 | {title} 24 | 25 |

26 |
27 | 28 |
29 |
30 |
31 |

{excerpt}

32 | 33 |
34 |
35 |
36 | ) 37 | } 38 | -------------------------------------------------------------------------------- /components/intro.js: -------------------------------------------------------------------------------- 1 | import { CMS_NAME } from '../lib/constants' 2 | 3 | export default function Intro() { 4 | return ( 5 |
6 |

7 | Blog. 8 |

9 |

10 | A statically generated blog example using{' '} 11 | 15 | Next.js 16 | {' '} 17 | and {CMS_NAME}. 18 |

19 |
20 | ) 21 | } 22 | -------------------------------------------------------------------------------- /components/layout.js: -------------------------------------------------------------------------------- 1 | import Alert from '../components/alert' 2 | import Footer from '../components/footer' 3 | import Meta from '../components/meta' 4 | 5 | export default function Layout({ preview, children }) { 6 | return ( 7 | <> 8 | 9 |
10 | 11 |
{children}
12 |
13 |