| # 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/app/building-your-application/routing/layouts-and-templates) 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 |
|
|
| [](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) |
|
|
| ### Related examples |
|
|
| - [AgilityCMS](/examples/cms-agilitycms) |
| - [Builder.io](/examples/cms-builder-io) |
| - [ButterCMS](/examples/cms-buttercms) |
| - [Contentful](/examples/cms-contentful) |
| - [Cosmic](/examples/cms-cosmic) |
| - [DatoCMS](/examples/cms-datocms) |
| - [DotCMS](/examples/cms-dotcms) |
| - [Drupal](/examples/cms-drupal) |
| - [Enterspeed](/examples/cms-enterspeed) |
| - [Ghost](/examples/cms-ghost) |
| - [GraphCMS](/examples/cms-graphcms) |
| - [Kontent.ai](/examples/cms-kontent-ai) |
| - [MakeSwift](/examples/cms-makeswift) |
| - [Payload](/examples/cms-payload) |
| - [Plasmic](/examples/cms-plasmic) |
| - [Prepr](/examples/cms-prepr) |
| - [Prismic](/examples/cms-prismic) |
| - [Sanity](/examples/cms-sanity) |
| - [Sitecore XM Cloud](/examples/cms-sitecore-xmcloud) |
| - [Sitefinity](/examples/cms-sitefinity) |
| - [Storyblok](/examples/cms-storyblok) |
| - [TakeShape](/examples/cms-takeshape) |
| - [Tina](/examples/cms-tina) |
| - [Umbraco](/examples/cms-umbraco) |
| - [Umbraco heartcore](/examples/cms-umbraco-heartcore) |
| - [Webiny](/examples/cms-webiny) |
| - [WordPress](/examples/cms-wordpress) |
| - [Blog Starter](/examples/blog-starter) |
|
|
| ## 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). |
|
|
