mirror of
https://github.com/Pomax/BezierInfo-2.git
synced 2025-08-31 20:11:59 +02:00
Merge branch 'pure-html' of github.com:pomax/bezierinfo-2 into pure-html
This commit is contained in:
18
README.md
18
README.md
@@ -1,6 +1,6 @@
|
||||
# BezierInfo-2: a dev repository
|
||||
|
||||
This is the development repository for ["A Primer on Bézier Curves"](https://pomax.github.io.bezierinfo).
|
||||
This is the development repository for ["A Primer on Bézier Curves"](https://pomax.github.io.bezierinfo), itself hosted as https://pomax.github.io/BezierInfo-2/
|
||||
|
||||
The primer is currently being rewritten from a React application to a pure HTML/CSS/Vanilla-JS tech stack.
|
||||
|
||||
@@ -10,18 +10,18 @@ See https://github.com/Pomax/BezierInfo-2/issues/257 for the current rewrite sta
|
||||
|
||||
## Building everything
|
||||
|
||||
Use the latest Node v14, with all dependencies installed via `npm install`. Note that [node-canvas](https://github.com/Automattic/node-canva) has [special instructions](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows) because it's going to have to compile itself (however, JPEG support is not needed for this project).
|
||||
|
||||
- The general single-build-pass command is simply `npm start`
|
||||
- Continuous development is `npm test`
|
||||
|
||||
Specialised commands:
|
||||
#### Specialised commands:
|
||||
|
||||
- `pretty` runs prettier over the resultant HTML files
|
||||
- `link-checker` runs link checking on the resultant HTML files
|
||||
- `polish` runs `pretty` followed by `link-checker`
|
||||
- `svgo:pretty` runs a script that reformats the SVG files to an easier-for-humans form (**note: might be broken?)**
|
||||
- `clean` cleans up the timing file and temp directory
|
||||
- `lint:tools` runs prettier on all javascript in the `src` dir
|
||||
- `lint:lib` runs prettier on all site javascript (including the custom element code)
|
||||
- `polish` runs `prettier` on the final .html files, as well as `link-checker` to make sure there are no dead links in the content.
|
||||
|
||||
#### Even more specialized commands:
|
||||
|
||||
Please see the package.json `"scripts"` section for the full list of commands. Most of these are just build chain steps, and running them on their own basically makes no sense.
|
||||
|
||||
## Weird personal dependencies?
|
||||
|
||||
|
Reference in New Issue
Block a user