jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Provide more clarity on development basic commands (#17423)

Browse Source
This commit is contained in:
James M. Greene
2021-01-21 12:42:38 -06:00
committed by GitHub
parent c51f5390d4
commit 054f9abc73
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
contributing/development.md
View File

@@ -15,7 +15,7 @@ Once you've installed Node.js (which includes the popular `npm` package manager)
```sh ```sh
git clone https://github.com/github/docs git clone https://github.com/github/docs
cd docs cd docs
npm install npm ci
npm run build npm run build
npm start npm start
``` ```
@@ -24,7 +24,9 @@ You should now have a running server! Visit [localhost:4000](http://localhost:40
When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in your terminal window. When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in your terminal window.
Note that `npm run build` is a one-time step that create static assets. Note that `npm ci` and `npm run build` are steps that should typically only need to be run once each time you pull the latest for a branch.
- `npm ci` does a clean install of dependencies, without updating the `package-lock.json` file
- `npm run build` creates static assets, such as the `dist/index.js` and `dist/index.css` files
### Using GitHub Codespaces ### Using GitHub Codespaces