archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rsnext/examples/blog/README.md

39 lines
1.8 KiB
Markdown
Raw Normal View History

[examples] Add portfolio starter kit. (#23212)
2021-03-22 01:44:59 +01:00
# Portfolio Starter Kit
This portfolio is built with **Next.js** and a library called [Nextra](https://nextra.vercel.app/). 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.
1. Update your name and site URL for the RSS feed in `scripts/gen-rss.js`.
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 21:33:16 +02:00
1. Update the meta tags in `pages/_document.tsx`.
[examples] Add portfolio starter kit. (#23212)
2021-03-22 01:44:59 +01:00
1. Update the posts inside `pages/posts/*.md` with your own content.
## Deploy your own
Change README structure in examples (#35349) Changed the README structure in all examples to take out the Stackblitz button and include it as a link instead using a [bash script](https://gist.github.com/Nutlope/a8f3556a5a401e32a8c6278b782ebf8a/revisions). I also added the Vercel deploy button to 15 READMEs that didn't have it.
2022-03-16 22:39:26 +01:00
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/blog)
[examples] Add portfolio starter kit. (#23212)
2021-03-22 01:44:59 +01:00
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/blog&project-name=portfolio&repository-name=portfolio)
## How to use
add pnpm link to docs (#37221) ## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) Co-authored-by: Steven <steven@ceriously.com>
2022-05-27 21:46:38 +02:00
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
[examples] Add portfolio starter kit. (#23212)
2021-03-22 01:44:59 +01:00
```bash
npx create-next-app --example blog my-blog
# or
yarn create next-app --example blog my-blog
Updated create-next-app docs to include pnpm usage (#35755) This PR updates the docs and examples for `create-next-app` to include pnpm usage. The following script was used to update every example README: ```js const fs = require('fs') const examples = fs.readdirSync('./examples') for (let example of examples) { const filename = `./examples/${example}/README.md` const markdown = fs.readFileSync(filename, 'utf8') const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm') const output = markdown.replace(regex, (yarn, group) => { const pnpm = `pnpm create next-app -- --example ${group}` return `${yarn}\n# or\n${pnpm}` }) fs.writeFileSync(filename, output) } ```
2022-03-30 23:03:21 +02:00
# or
Update `pnpm create next-app` for latest pnpm 6 and 7 (#37254) This command changed in pnpm [6.32.13](https://github.com/pnpm/pnpm/releases/tag/v6.32.13) and [7.1.1](https://github.com/pnpm/pnpm/releases/tag/v7.1.1) so lets update it since its been a few weeks and we can expect pnpm users to update more regularly than npm users. - Fixes https://github.com/vercel/next.js/pull/37240 - Fixes https://github.com/vercel/next.js/pull/37045 - Fixes https://github.com/vercel/next.js/pull/37032 - Fixes https://github.com/vercel/next.js/pull/36602 - Fixes https://github.com/vercel/next.js/pull/36496
2022-05-27 23:21:40 +02:00
pnpm create next-app --example blog my-blog
[examples] Add portfolio starter kit. (#23212)
2021-03-22 01:44:59 +01:00
```
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
Reference in a new issue Copy permalink