88ac118d1c
# Demo: https://next-blog-demo.enterspeed.com/ Added `with-enterspeed` to examples. Linked to `with-enterspeed` in related documentation: - docs/advanced-features/preview-mode.md - docs/basic-features/data-fetching/overview.md - docs/basic-features/pages.md Linked to `with-enterspeed` in related examples: - examples/blog-starter/README.md - examples/cms-agilitycms/README.md - examples/cms-builder-io/README.md - examples/cms-buttercms/README.md - examples/cms-contentful/README.md - examples/cms-cosmic/README.md - examples/cms-datocms/README.md - examples/cms-drupal/README.md - examples/cms-ghost/README.md - examples/cms-graphcms/README.md - examples/cms-kontent/README.md - examples/cms-prepr/README.md - examples/cms-prismic/README.md - examples/cms-sanity/README.md - examples/cms-storyblok/README.md - examples/cms-strapi/README.md - examples/cms-takeshape/README.md - examples/cms-tina/README.md - examples/cms-umbraco-heartcore/README.md
63 lines
3 KiB
Markdown
63 lines
3 KiB
Markdown
# 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)
|
|
|
|
[](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).
|