Skip to content

Docs: improve README template formatting #1385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rolloerro wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −19
Open

Docs: improve README template formatting #1385

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions plop-templates/example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
# -- PLOP TITLE HERE -- example
Example: Basic Next.js App

This example shows how -------------------------
This example demonstrates a minimal Next.js application structure suitable for learning, testing, and quick prototyping with Vercel.

## Demo
Getting Started

https://-- PLOP EXAMPLE NAME HERE --.vercel.app
You can use this example in one of the following ways.

## How to Use
One-Click Deploy

You can choose from one of the following two methods to use this repository:
Deploy the example instantly using Vercel:

### One-Click Deploy
Deploy with Vercel

Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=vercel-examples):
Clone and Run Locally

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/examples/tree/main/-- PLOP PATH HERE --&project-name=-- PLOP EXAMPLE NAME HERE --&repository-name=-- PLOP EXAMPLE NAME HERE --)
Create a new project using create-next-app:

### Clone and Deploy
pnpm create next-app

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
Then start the development server:

```bash
pnpm create next-app --example https://github.com/vercel/examples/tree/main/-- PLOP PATH HERE --
```
pnpm dev

Next, run Next.js in development mode:
Open http://localhost:3000 in your browser to see the result.

```bash
pnpm dev
```
Deployment

Deploy the project to the cloud using Vercel:

Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=edge-middleware-eap) ([Documentation](https://nextjs.org/docs/deployment)).
https://vercel.com/docs