Skip to content

Commit e8eeeff

Browse files
committed
Add package.json script, update READMEs
1 parent ae87643 commit e8eeeff

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

11ty/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ Common tasks:
2323
- http://localhost:8080/techniques
2424
- http://localhost:8080/understanding
2525

26-
Maintenance tasks (for working with Eleventy config and supporting files under this subdirectory):
26+
Maintenance tasks (for working with Eleventy config and supporting files used by the build):
2727

2828
- `npm run check` checks for TypeScript errors
2929
- `npm run fmt` formats all TypeScript files
30+
- `npm run changelog` generates data for the Techniques Change Log
3031

3132
## Environment Variables
3233

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,9 +219,8 @@ appended to the "Note" title in applicable versions, and the note will be hidden
219219

220220
### Techniques Change Log
221221

222-
At the time of writing (November 2024), the Change Log in the Techniques index is identical between WCAG 2.1 and 2.2.
223-
These have been split out into separate version-specific includes under `_includes/techniques/changelog/*.html`
224-
for future-proofing in support of building multiple versions of informative documents from the same branch.
222+
Data for the Techniques Change Log is now generated automatically by a script that reads git history;
223+
see [Eleventy Usage](11ty/README.md#usage).
225224

226225
## Working Examples
227226

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"build": "tsx node_modules/@11ty/eleventy/cmd.cjs --config=eleventy.config.ts",
99
"check": "tsc",
1010
"fmt": "prettier . -w",
11+
"changelog": "tsx 11ty/generate-techniques-changelog-data.ts",
1112
"publish-w3c": "WCAG_VERSION=22 WCAG_JSON=1 WCAG_MODE=publication npm run build && tsx 11ty/cp-cvs.ts",
1213
"publish-w3c:21": "WCAG_VERSION=21 WCAG_JSON=1 WCAG_MODE=publication npm run build && WCAG_VERSION=21 tsx 11ty/cp-cvs.ts",
1314
"start": "tsx watch node_modules/@11ty/eleventy/cmd.cjs --config=eleventy.config.ts --serve --incremental"

0 commit comments

Comments
 (0)