You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOP.md
+10-12Lines changed: 10 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ The typical Primer workflow looks something like this:
36
36
Run `npm install` to install the npm dependencies.
37
37
38
38
## 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:
40
40
41
41
```sh
42
42
npm start
@@ -73,29 +73,27 @@ This should open up the site in your browser (if not, navigate to `http://localh
73
73
### Code blocks
74
74
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).
75
75
76
-
Note: At this time, we do not load any stories from `src/**/stories.js`.
77
76
78
77
## 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>`:
80
79
80
+
*`fresh` does a "fresh" npm install (like `npm install -f`)
81
81
*`dist` runs `script/dist`, which creates CSS bundles of all the `index.scss` files in `src/`.
82
82
*`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.
85
86
*`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.
87
89
*`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/`.
89
90
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.
0 commit comments