Skip to content
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

update readme; add npm and yarn instructions #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update readme; add npm and yarn instructions #13

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
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,37 @@ Click the button to clone this repository and deploy it on Vercel:

## Local Development

First, run `pnpm i` to install the dependencies.
### Clone the repository

Then, run `pnpm dev` to start the development server and visit localhost:3000.
```sh
https://github.com/shuding/nextra-docs-template.git
cd nextra-docs-template
```

### Install dependencies and run development server

**npm**

```sh
npm install
npm run dev
```

**yarn**

```sh
yarn install
yarn dev
```

**pnpm**

```sh
pnpm i
pnpm dev
```

This will start the development server and you can view the app in your browser at http://localhost:3000.

## License

Expand Down