rsnext/examples/blog-starter
Steven Tey 71fa80b665
Make cover image full width (#42916)
<!--
Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change that you're making:
-->

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2022-11-14 12:48:48 -08: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 [Docs] Update examples to favour functional _document (#39871) 2022-08-23 18:52:31 +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 Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05: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 Add Enterspeed blog example (#35897) 2022-09-30 01:48:00 +02: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).