primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-22 10:49:41 +03:00
Code Issues Projects Releases Wiki Activity

Remove references to npm start and dev (#2553)

Browse Source
This commit is contained in:
Jon Rohan 2023-11-30 15:02:27 -08:00 committed by GitHub
parent f0b0d208cf
commit ef9337edb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 2 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
DEVELOP.md
View File

@ -27,16 +27,6 @@ Here's what you need to know about how the files are structured in both git and
Run `npm install` to install the npm dependencies. Run `npm install` to install the npm dependencies.
## Docs site
The Primer CSS docs are built with React using [Doctocat](https://primer.style/doctocat) and automatically deployed on every push to this repo with [Now]. You can run the server locally with:
```sh
npm start
```
Then visit http://localhost:8000 to view the site.
### The docs directory ### The docs directory
The [docs directory](../docs/) contains all of the documentation files in our docs site. Files are nested in the `/content` folder. The [docs directory](../docs/) contains all of the documentation files in our docs site. Files are nested in the `/content` folder.
@ -66,10 +56,8 @@ Stories are individual `.jsx` or `.mdx` files that contain component HTML for pr
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>`: 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>`:
- `dist` runs `script/dist`, which creates CSS bundles of all the `index.scss` files in `src/`. - `dist` runs `script/dist`, which creates CSS bundles of all the `index.scss` files in `src/`.
- `check-links` runs a link checker on your local development server (`localhost:3000`, started with `npm start`).
- `stylelint` lints the CSS source files. - `stylelint` lints the CSS source files.
- `eslint` lints the JavaScript source files. - `eslint` lints the JavaScript source files.
- `start` runs the documentation site locally (alias: `dev`).
- `test` runs our test suite. - `test` runs our test suite.
- `storybook` runs storybook local development server. - `storybook` runs storybook local development server.

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "@primer/css", "name": "@primer/css",
"version": "21.0.9", "version": "21.0.10",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@primer/css", "name": "@primer/css",
"version": "21.0.9", "version": "21.0.10",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@primer/primitives": "^7.12.0", "@primer/primitives": "^7.12.0",

1
package.json
View File

@ -34,7 +34,6 @@
"stylelint:add-disables": "script/stylelint-add-disables.js 'src/**/*.scss'", "stylelint:add-disables": "script/stylelint-add-disables.js 'src/**/*.scss'",
"eslint": "eslint deprecations.js __tests__ script", "eslint": "eslint deprecations.js __tests__ script",
"prepublishOnly": "script/prepublish", "prepublishOnly": "script/prepublish",
"start": "npm run dev",
"pretest": "npm run dist && script/pretest", "pretest": "npm run dist && script/pretest",
"test": "NODE_OPTIONS=--experimental-vm-modules npx jest", "test": "NODE_OPTIONS=--experimental-vm-modules npx jest",
"release": "changeset publish", "release": "changeset publish",