rsnext/examples/blog-starter
Tom 3e178bb801
add pnpm link to docs (#37221)
## Documentation / Examples

- [x] Make sure the linting passes by running `yarn lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)


Co-authored-by: Steven <steven@ceriously.com>
2022-05-27 15:46:38 -04:00
..
_posts [Fix] common misspelling errors (#15288) 2020-07-19 04:38:20 +00:00
components [examples] Add Tina CMS blog starter (#35045) 2022-03-05 17:08:49 +00:00
lib Update all CMS examples dependencies. (#33580) 2022-02-04 00:07:35 +00:00
pages Fix variable shadowing in blog-starter example (#13988) 2020-06-10 03:30:22 +00:00
public Fixed Favicons URL mismatch across the project in [examples/blog-starter] (#29990) 2021-10-19 03:37:44 +00:00
styles chore(blog-starter): update tailwindcss to v3 (#32398) 2021-12-13 15:25:45 +00:00
.gitignore Added .gitignore to examples that are deployed to vercel (#15127) 2020-07-16 10:52:23 -04:00
package.json [examples] Add Tina CMS blog starter (#35045) 2022-03-05 17:08:49 +00:00
postcss.config.js Update all CMS examples dependencies. (#33580) 2022-02-04 00:07:35 +00:00
README.md add pnpm link to docs (#37221) 2022-05-27 15:46:38 -04:00
tailwind.config.js chore(blog-starter): update tailwindcss to v3 (#32398) 2021-12-13 15:25:45 +00:00

A statically generated blog example using Next.js and Markdown

This example showcases Next.js's Static Generation 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 and 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 and also sent in props to the page.

Demo

https://next-blog-starter.vercel.app/

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example blog-starter blog-starter-app

or

yarn create next-app --example blog-starter blog-starter-app
# or
pnpm create next-app -- --example blog-starter blog-starter-app

Your blog should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.

Deploy it to the cloud with Vercel (Documentation).

Notes

This blog-starter uses Tailwind CSS (v3.0).