Skip to content

Commit 29d94fc

Browse files
authored
Merge pull request #855 from primer/develop-updates
Update npm script instructions, etc.
2 parents 04099f8 + f2ae84e commit 29d94fc

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

DEVELOP.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The typical Primer workflow looks something like this:
3636
Run `npm install` to install the npm dependencies.
3737

3838
## Docs site
39-
The Primer CSS docs are built with React using [Primer Components](https://primer.style/components) and automatically deployed on every push to this repo using our [primer/deploy action](/primer/deploy). You can run the server locally with:
39+
The Primer CSS docs are built with React using [Primer Components](https://primer.style/components) and automatically deployed on every push to this repo with [Now]. You can run the server locally with:
4040

4141
```sh
4242
npm start
@@ -73,29 +73,27 @@ This should open up the site in your browser (if not, navigate to `http://localh
7373
### Code blocks
7474
All `html` fenced code blocks in `src/**/*.md` will be rendered as stories and listed under the relevant module's name in the left-hand nav. File changes should trigger a live reload automatically (after a brief delay).
7575

76-
Note: At this time, we do not load any stories from `src/**/stories.js`.
7776

7877
## Scripts
79-
Our [`package.json`](package.json) houses a collection of [run-scripts] that we use to maintain, test, build, and publish Primer CSS, notably:
78+
Our [`package.json`](package.json) houses a collection of [run-scripts] that we use to maintain, test, build, and publish Primer CSS. Run `npm run <script>` with any of the following values for `<script>`:
8079

80+
* `fresh` does a "fresh" npm install (like `npm install -f`)
8181
* `dist` runs `script/dist`, which creates CSS bundles of all the `index.scss` files in `src/`.
8282
* `check-links` runs a link checker on your local development server (`localhost:3000`, started with `npm start`).
83-
* `lint` lints all of our SCSS source files.
84-
* `lint-js` lints the docs site and supporting scripts.
83+
* `lint` lints both our SCSS and JavaScript source files.
84+
* `lint-css` lints our SCSS source files.
85+
* `lint-js` lints the JavaScript source files.
8586
* `now-build` and `now-start` are run on [Now] to build and start the docs site server. `now-test` runs them both in order.
86-
* `test-urls` compares a (pre-generated) list of paths from the [Primer Style Guide](https://styleguide.github.com/primer/) to files in `pages/css`, and lets us know if we've inadvertently deleted or renamed anything.
87+
* `start` runs the documentation site locally (alias: `dev`).
88+
* `test-urls` compares a (pre-generated) list of paths from the **deprecated** [Primer Style Guide](https://styleguide.github.com/primer/) to files in `pages/css`, and lets us know if we've inadvertently deleted or renamed anything.
8789
* `test-migrate` tests the [`primer-migrate`](MIGRATING.md#primer-migrate) command line utility.
88-
* `watch` runs the sync script in watch mode, copying files as they're changed from `src/` to `pages/css/`.
8990

90-
You can list all of the available scripts with:
91-
92-
```sh
93-
npm run
94-
```
91+
The above list may not always be up-to-date. You can list all of the available scripts by calling `npm run` with no other arguments.
9592

9693

9794
[@primer/css]: https://www.npmjs.com/package/@primer/css
9895
[run-scripts]: https://docs.npmjs.com/cli/run-script
9996
[storybook]: https://storybook.js.org/
97+
[now]: https://zeit.co/now
10098
[npm]: https://www.npmjs.com/
10199
[npx]: https://www.npmjs.com/package/npx

0 commit comments

Comments
 (0)