archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rsnext/examples/blog/README.md
Max Proske 0f4333a5a3
chore(examples): Convert blog example to TypeScript (#38095) 
Converted Blog example over to TypeScript to match the Contribution guidelines.

I also simplified the example by removing `_document.js` and prettier from `package.json`.

## Documentation / Examples

- [X] Make sure the linting passes by running `pnpm lint`
- [X] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
2022-07-06 19:33:16 +00:00

1.8 KiB
Raw Blame History

Portfolio Starter Kit

This portfolio is built with Next.js and a library called Nextra. It allows you to write Markdown and focus on the content of your portfolio. This starter includes:

  • Automatically configured to handle Markdown/MDX
  • Generates an RSS feed based on your posts
  • A beautiful theme included out of the box
  • Easily categorize posts with tags
  • Fast, optimized web font loading

https://demo.vercel.blog

Configuration

  1. Update your name in theme.config.js or change the footer.
  2. Update your name and site URL for the RSS feed in scripts/gen-rss.js.
  3. Update the meta tags in pages/_document.tsx.
  4. Update the posts inside pages/posts/*.md with your own content.

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

Deploy it to the cloud with Vercel (Documentation).