Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove references to npm start and dev #2553

Merged
merged 1 commit into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## 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](../docs/) contains all of the documentation files in our docs site. Files are nested in the `/content` folder.
Expand Down Expand Up @@ -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>`:

- `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.
- `eslint` lints the JavaScript source files.
- `start` runs the documentation site locally (alias: `dev`).
- `test` runs our test suite.
- `storybook` runs storybook local development server.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
"stylelint:add-disables": "script/stylelint-add-disables.js 'src/**/*.scss'",
"eslint": "eslint deprecations.js __tests__ script",
"prepublishOnly": "script/prepublish",
"start": "npm run dev",
"pretest": "npm run dist && script/pretest",
"test": "NODE_OPTIONS=--experimental-vm-modules npx jest",
"release": "changeset publish",
Expand Down
Loading