Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
update local development docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Oct 17, 2022
1 parent 0be165b commit 2f742a4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 29 deletions.
23 changes: 2 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,28 +44,9 @@ Nuxt's goal is to make web development intuitive and performant with a great dev
</tbody>
</table>

## 💻 Development
## Local Development

- Clone repository
- Ensure you have the latest LTS version of Node.js installed
- Install dependencies with `npx pnpm install`
- Run `npx pnpm stub` to activate passive development
- Open playground with `npx pnpm dev`

Learn more about in our documentation on [how to contribute to Nuxt](https://v3.nuxtjs.org/community/contribution).

## 📖 Documentation

We are using [Docus](https://nuxtlabs.com/docus) for documentation (*It is planned to be open sourced in the following weeks*).

We recommend to install the [Docus extension](https://marketplace.visualstudio.com/items?itemName=NuxtLabs.docus) for VS Code.

- Run `npx pnpm stub` once in the root directory
- Go into the docs directory: `cd docs`
- Install docs dependencies with `npx yarn install`
- Run `npx yarn dev` to start Docus in development mode

The pages are generated from [docs/content/](./docs/content), you can start editing them to start helping us on documenting Nuxt 3 💚
Follow the docs to [Set Up Your Local Development Environment](https://v3.nuxtjs.org/community/framework-contribution#set-up-your-local-development-environment) to contribute to the framework and documentation.

## License

Expand Down
20 changes: 12 additions & 8 deletions docs/content/5.community/4.framework-contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ To contribute to Nuxt, you need to set up a local environment.

1. Ensure using the latest Node.js (16.x)

1. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
1. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` to have `pnpm` and `yarn`

1. Run `yarn install` to install the dependencies.
1. Run `pnpm install` to install the dependencies.

> If you are adding a dependency, please use `yarn add`. The `yarn.lock` file is the source of truth for all Nuxt dependencies.
> If you are adding a dependency, please use `pnpm add`. The `pnpm-lock.yaml` file is the source of truth for all Nuxt dependencies.
1. Run `yarn stub` to activate the passive development system
1. Run `pnpm build:stub` to activate the passive development system

1. Check out a branch where you can work and commit your changes:

Expand All @@ -86,7 +86,11 @@ git checkout -b my-new-branch

### Set Up Documentation Website in Local Environment

1. Follow steps to set up [local development environment](#set-up-your-local-development-environment)
1. Change to the `docs/` directory using `cd docs/`
1. Install docs dependencies using `yarn install`
1. Start docs in development mode using `yarn dev`
We are using [Docus](https://nuxtlabs.com/docus) for documentation.

- Run `pnpm build:stub` once in the root directory
- Go into the docs directory: `cd docs`
- Install docs dependencies using `yarn install`
- Run `yarn dev` to start docs in development mode

We recommend to install the [Docus extension](https://marketplace.visualstudio.com/items?itemName=NuxtLabs.docus) for VS Code.

0 comments on commit 2f742a4

Please sign in to comment.