Skip to content

w3c/wai-website-data

Repository files navigation

WAI website data

This repository contains data shared across multiple W3C WAI repositories.

How to use the files

Incorporate wai-website-data to your repository

From the root directory of your git repository, run:

git submodule add https://github.com/w3c/wai-website-data.git _external/data

When it finishes, the content of the wai-website-data repository will be in the external/data directory.

A .gitsubmodules file will also be created with the following information.

[submodule "_external/data"]
path = _external/data
url = https://github.com/w3c/wai-website-data.git

If the file already exists, it will be updated accordingly.

Symlink the files you need

To use the files, create symlinks where you need them:

  1. Navigate to the folder where you want the file to appear
  2. Create a symlink pointing to the corresponding file in the external_data folder, using the ln -s command.

For example:

cd _data
ln -s ../_external/data/navigation.yml

This makes the shared navigation.yml available in the _data folder.

How to update wcag22.json

To update wcag22.json, run the following within the project directory:

node _update-wcag-json.mjs

This requires Node.js version 20 or later.

About

Shared data used for the W3C WAI website

Resources

Code of conduct

Stars

Watchers

Forks

Contributors 31