rsnext/examples/blog-starter-typescript
Aleksa Cukovic bcd8de3262
Add *.tsbuildinfo to .gitignore of examples that use typescript (#38005)
I added ` *.tsbuildinfo` to gitignores of examples that use typescript and don't already have it. By use typescript I mean have `tsconfig` somewhere in their directory tree. 

I used the following script to update the files:

```bash
#!/bin/bash

set -eou pipefail

cd examples
examples=`git ls-files . | grep tsconfig | xargs dirname | grep -v "/"`

for example in $examples; do
    if ! grep -q tsbuildinfo $example/.gitignore; then
        gitignore="$example/.gitignore"
        echo $gitignore
        tail -c1 $gitignore | read -r _ || echo >> $gitignore
        echo -e "\n# typescript\n*.tsbuildinfo" >> $gitignore
    fi
done
```
2022-06-26 11:17:44 +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 chore(blog-starter-typescript): update tailwindcss to v3 (#32579) 2021-12-16 17:43:48 +00:00
lib Update remark in blog-starter-typescript (#31393) 2022-02-05 15:56:24 -06: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 chore(blog-starter-typescript): update tailwindcss to v3 (#32579) 2021-12-16 17:43:48 +00:00
types [Examples] Added blog-starter-typescript (#12981) 2020-05-23 20:34:35 +02:00
.gitignore Add *.tsbuildinfo to .gitignore of examples that use typescript (#38005) 2022-06-26 11:17:44 +00:00
next-env.d.ts Include submodules in exported type definition (#28316) 2021-11-26 14:46:56 +01:00
package.json Update remark in blog-starter-typescript (#31393) 2022-02-05 15:56:24 -06:00
postcss.config.js Continue: Update blog-starter-typescript postcss.config.js (#27314) 2021-07-19 19:34:01 -05:00
README.md Update pnpm create next-app for latest pnpm 6 and 7 (#37254) 2022-05-27 21:21:40 +00:00
tailwind.config.js chore(blog-starter-typescript): update tailwindcss to v3 (#32579) 2021-12-16 17:43:48 +00: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.

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-typescript blog-starter-typescript-app
# or
yarn create next-app --example blog-starter-typescript blog-starter-typescript-app
# or
pnpm 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

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