Skip to content

Commit 9588608

Browse files
committed
Add about development npm scripts docs
1 parent 5447e2e commit 9588608

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

src/content/docs/about/development.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ Tech Docs is a [Node.js](https://nodejs.org) application, built with [Astro](htt
1515
Tech Docs depends on the following open source software (see `.nvmrc` and `package.json` for versions):
1616

1717
1. [Node.js](https://nodejs.org) - JavaScript development and build environment
18-
2. [Astro](https://astro.build/) - Static site generator conceptually based on "components" (React, Vue, Svelte, etc.) rather than "templates" (Handlebars, Pug, Haml, etc.)
18+
2. [Astro](https://astro.build/) - Static site generator conceptually based on "components" (React, Vue, Svelte, etc.) rather than "templates" (Jekyll, Handlebars, Pug, etc.)
1919
1. [Starlight](https://starlight.astro.build/) - Astro plugin and theme for documentation websites
2020
2. [Sharp](https://sharp.pixelplumbing.com/) - Image transformation library used by Astro
2121
3. [Cypress](https://www.cypress.io/) - End-to-end testing framework
22-
4. [Stylelint](https://stylelint.io/) - CSS linter used locally in text editors and in CI for testing
22+
4. [Stylelint](https://stylelint.io/) - CSS linter used locally in text editors and remotely in [CI](#cicd) for testing
2323
1. [stylelint-config-recommended](https://github.com/stylelint/stylelint-config-recommended) - Base set of lint rules
2424
2. [postcss-html](https://github.com/ota-meshi/postcss-html) - PostCSS syntax for parsing HTML (and HTML-like including .astro files)
2525
3. [stylelint-config-html](https://github.com/ota-meshi/stylelint-config-html) - Allows Stylelint to parse .astro files
26-
5. [Prettier](https://prettier.io/) - Source code formatter used locally in text editors and in CI for testing
26+
5. [Prettier](https://prettier.io/) - Source code formatter used locally in text editors and remotely in [CI](#cicd) for testing
2727
1. [prettier-plugin-astro](https://github.com/withastro/prettier-plugin-astro) - Allows Prettier to parse .astro files via the command line
2828

2929
## Local development
@@ -59,6 +59,22 @@ npm run build
5959
Serve the built output by running `npm run preview` after a build.
6060
:::
6161

62+
### Available `npm` scripts
63+
64+
The following scripts are made available via `package.json`. Invoke any script on the command line from the project root by prepending it with the `npm run` command, ie: `npm run start`.
65+
66+
- `start` -- run Astro dev server
67+
- `build` -- build Tech Docs for production
68+
- `preview` -- serve the static build
69+
- `astro` -- get Astro help
70+
- `test:dev` -- run tests in development mode
71+
- `test:prod` -- run tests in production mode
72+
- `test` -- defaults to run tests in production mode
73+
- `prettier:check` -- check formatting with Prettier
74+
- `prettier:fix` -- fix possible format errors with Prettier
75+
- `stylelint:check` -- lint CSS with Stylelint
76+
- `stylelint:fix` -- fix possible CSS lint errors with Stylelint
77+
6278
## Search
6379

6480
Site search is a [Starlight feature](https://starlight.astro.build/guides/site-search/):
@@ -169,4 +185,4 @@ npm run stylelint:fix
169185

170186
### CI/CD
171187

172-
Before new changes are accepted into the code base, the [end-to-end](#end-to-end) and [code style](#code-style) tests need to pass. Tech Docs uses [GitHub Actions](https://docs.github.com/en/actions) for its continuous integration and continuous delivery (CI/CD) platform, which automates the testing and deployment process. The tests are defined in yaml files found in `.github/workflows` and are run automatically when new changes are proposed.
188+
Before new changes are accepted into the code base, the [end-to-end](#end-to-end) and [code style](#code-style) tests need to pass. Tech Docs uses [GitHub Actions](https://docs.github.com/en/actions) for its continuous integration and continuous delivery (CI/CD) platform, which automates the testing and deployment processes. The tests are defined in yaml files found in `.github/workflows/` and are run automatically when new changes are proposed.

0 commit comments

Comments
 (0)