rsnext/examples/blog-starter-typescript
Oiva Eskola c78b249c66
Fix falsy values not being returned in post fields (#29011)
I imported a bunch of old markdown posts to the blog-starter example but some of the post metadata was not returned by the API in the example code.

For example, having `published: false` in post metadata was not returned in the item fields.

The problem was in check:
```
if (data[field]) {
  items[field] = data[field]
}
```
This rejects all falsy values in addition to fields that are not set. Checking only for `undefined` should fix this issue.

I didn't find existing integration tests for the blog example nor an issue describing this problem.



## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`
2021-09-11 14:24:24 +00:00
..
@types [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00
_posts [Fix] common misspelling errors (#15288) 2020-07-19 04:38:20 +00:00
components Update to Tailwind CSS 2.0 in blog-starter-typescript example (#20664) 2021-01-01 18:45:55 +00:00
lib Fix falsy values not being returned in post fields (#29011) 2021-09-11 14:24:24 +00:00
pages [typo] posts.map( posts => {} ) in examples/blog-starter-typescript (#27523) 2021-07-27 04:56:19 +00:00
public [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00
styles [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00
types [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00
.gitignore Added .gitignore to examples that are deployed to vercel (#15127) 2020-07-16 10:52:23 -04:00
next-env.d.ts next-env.d.ts note in templates (#27983) 2021-08-12 20:36:53 +00:00
package.json Remove licence from all example/package.json that has them (#28007) 2021-08-14 10:48:39 -05:00
postcss.config.js Continue: Update blog-starter-typescript postcss.config.js (#27314) 2021-07-19 19:34:01 -05:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00
tailwind.config.js [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00
tsconfig.json [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00

A statically generated blog example using Next.js, Markdown, and TypeScript

This is the existing blog-starter plus TypeScript.

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.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

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

npx create-next-app --example blog-starter-typescript blog-starter-typescript-app
# or
yarn create next-app --example blog-starter-typescript blog-starter-typescript-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-typescript uses Tailwind CSS. To control the generated stylesheet's filesize, this example uses Tailwind CSS' v2.0 purge option to remove unused CSS.

Tailwind CSS v2.0 no longer supports Node.js 8 or 10. To build your CSS you'll need to ensure you are running Node.js 12.13.0 or higher in both your local and CI environments.