rsnext/examples/blog-starter
Riccardo Di Maio 229817d50d
Fix typos in blog-starter and blog-starter-typescript (#15807)
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2020-08-05 15:15:27 +02:00
..
_posts [Fix] common misspelling errors (#15288) 2020-07-19 04:38:20 +00:00
components Fix typos in blog-starter and blog-starter-typescript (#15807) 2020-08-05 15:15:27 +02:00
lib Upgrade to Prettier 2 (#13061) 2020-05-18 15:24:37 -04:00
pages Fix variable shadowing in blog-starter example (#13988) 2020-06-10 03:30:22 +00:00
public [Example] Use .jpg for images in blog-starter (#11176) 2020-03-26 12:45:17 -05:00
styles Update blog-starter to use Tailwind CSS v1.4's new built-in purge option (#12452) 2020-05-06 11:27:21 +02:00
.gitignore Added .gitignore to examples that are deployed to vercel (#15127) 2020-07-16 10:52:23 -04:00
package.json Add new import flow to CMS examples (#14053) 2020-06-11 23:44:23 +00:00
postcss.config.js Update blog-starter to use Tailwind CSS v1.4's new built-in purge option (#12452) 2020-05-06 11:27:21 +02:00
README.md Add c=1 to deploy buttons on CMS Examples (#14293) 2020-06-17 23:25:11 +00:00
tailwind.config.js Update blog-starter to use Tailwind CSS v1.4's new built-in purge option (#12452) 2020-05-06 11:27:21 +02: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.now.sh/

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Using create-next-app

Execute create-next-app with npm or Yarn 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

Download manually

Download the example:

curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/blog-starter
cd blog-starter

Install dependencies and run the example:

npm install
npm run dev

# or

yarn install
yarn dev

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. To control the generated stylesheet's filesize, this example uses Tailwind CSS' v1.4 purge option to remove unused CSS.