rsnext/examples/blog-starter
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
@types Replace JS blog-starter example with TS, deprecate blog-starter-typescript example (#38395) 2022-07-07 23:10:26 -05:00
_posts [Fix] common misspelling errors (#15288) 2020-07-19 04:38:20 +00:00
components Make cover image full width (#42916) 2022-11-14 12:48:48 -08:00
interfaces Replace JS blog-starter example with TS, deprecate blog-starter-typescript example (#38395) 2022-07-07 23:10:26 -05:00
lib Replace JS blog-starter example with TS, deprecate blog-starter-typescript example (#38395) 2022-07-07 23:10:26 -05:00
pages fix: <title> problem in example/blog-starter (#46122) 2023-02-19 20:20:26 +00:00
public Replace JS blog-starter example with TS, deprecate blog-starter-typescript example (#38395) 2022-07-07 23:10:26 -05:00
styles chore(blog-starter): update tailwindcss to v3 (#32398) 2021-12-13 15:25:45 +00:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
package.json Replace JS blog-starter example with TS, deprecate blog-starter-typescript example (#38395) 2022-07-07 23:10:26 -05:00
postcss.config.js Update all CMS examples dependencies. (#33580) 2022-02-04 00:07:35 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tailwind.config.js [Docs] Add config types to all examples (#40083) 2022-08-31 16:41:22 -05:00
tsconfig.json Replace JS blog-starter example with TS, deprecate blog-starter-typescript example (#38395) 2022-07-07 23:10:26 -05: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.

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
yarn create next-app --example blog-starter blog-starter-app
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

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