-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into accessible-load-more
- Loading branch information
Showing
74 changed files
with
1,369 additions
and
548 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
engine-strict=true | ||
chromedriver_force_download=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v20.4.0 | ||
v20.15.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ A place to learn and share with developers what makes web work accessible. This | |
|
||
- nvm: A Node version manager. It allows you to install several versions of node on the same machine and change versions easily. | ||
- [Here are instructions in how to install nvm](https://github.com/nvm-sh/nvm#usage) | ||
- After installing nvm, install a Node version >= 18 using nvm, ideally `nvm install 20.11.0` | ||
- After installing nvm, install a Node version >= 20.15.0 using nvm, ideally `nvm install 20.15.0` | ||
- npm: a Node Package Manager, usually installed alongside Node | ||
- More info: [Downloading and installing Node.js and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) | ||
- Lynx: A text-only browser used for testing for how a website will work without graphics turned on. | ||
|
@@ -74,6 +74,17 @@ A place to learn and share with developers what makes web work accessible. This | |
```sh | ||
git clone [email protected]:PublicisSapient/enable-a11y.git | ||
cd enable-a11y | ||
``` | ||
|
||
```sh | ||
nvm use | ||
``` | ||
|
||
This instructs nvm to use the Node version specified in the `.nvmrc` file located in the project root directory. | ||
|
||
> Note: If the specified version has not been installed yet, nvm will advise to install it after running the command above. | ||
|
||
```sh | ||
npm clean-install | ||
``` | ||
|
||
|
@@ -200,6 +211,44 @@ If you are trying to contribute to the Enable site from a forked version of this | |
|
||
You will need to update the version number that NPM broadcasts as the latest version number. Please use [np](https://github.com/sindresorhus/np) to do this (it is what we have used in the past). This should be done by development lead of the Enable project (as of this writing, this is [Zoltan Hawryluk](https://www.npmjs.com/~zoltandulac)). | ||
|
||
### Strcutured Data Markup | ||
|
||
Structured Data Markup is a way to label or tag the content on your website so that search engines and other platforms can better understand it. | ||
|
||
The Article and HowTo tags are two types of structured data markup that help search engines understand specific kinds of content. | ||
|
||
#### Article Tag: | ||
|
||
This is used to mark up articles, blog posts, or other written content. By using the Article tag, we help search engines identify the main parts of your article, like the headline. This can make your article show up better in search results, sometimes with extra features like the headline or image preview. | ||
|
||
#### HowTo Tag: | ||
|
||
This is used for content that gives step-by-step instructions on how to do something. When you use the HowTo tag, search engines can display your instructions in a more detailed way, often showing each step directly in the search results. | ||
|
||
Example of checkbox in the meta-info.json, where the mainEntity can be an array of 'Article' and 'HowTo' objects extracted from page: | ||
|
||
```json | ||
"checkbox.php": { | ||
"title": "How to Create Accessible Checkboxes", | ||
"desc": "Here is a step-by-step guide to creating accessible checkboxes", | ||
"url": "https://www.useragentman.com/enable/checkbox.php", | ||
"mainEntity":[ | ||
{ | ||
"type": "Article", | ||
"title": "A real styled HTML5 checkbox", | ||
"desc": "You can style an HTML5 checkbox using CSS easily.", | ||
"url": "https://www.useragentman.com/enable/checkbox.php#a-real-styled-html5-checkbox--heading" | ||
}, | ||
{ | ||
"type": "HowTo", | ||
"title": "Step-by-Step to make the styled checkboxe accessible", | ||
"desc": "See the dropdown to highlight each of the individual steps that make the styled checkboxe accessible", | ||
"url": "https://www.useragentman.com/enable/checkbox.php#developer-walkthrough-1" | ||
}, | ||
] | ||
} | ||
``` | ||
|
||
## References | ||
|
||
When testing using screen readers, these resources may be of help to you: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
#!/bin/bash | ||
|
||
i=`find css -name '*.css' -print` | ||
|
||
# echo $i | ||
OUTPUT=`grep -n 'font-size:[^\s\S]*[^@]px;' $i` | ||
# grep -b 'line-height:[^\s\S]*[^0-9];' $i | ||
RET="$?" | ||
|
||
if [ "$RET" = "0" ] | ||
then | ||
echo "The following CSS files must be changed so they don't use px units." | ||
echo "Please ensure you change the corresponding LESS files to use the @px mixin." | ||
echo "(e.g. instead of using 'font-size: 12px;', use 'font-size: 12 / @px;')." | ||
echo | ||
echo "$OUTPUT" | ||
echo | ||
exit 1; | ||
fi | ||
|
||
exit 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
#!/usr/bin/env node | ||
|
||
import chalk from 'chalk'; | ||
import { execSync } from 'child_process'; | ||
import fs from 'fs'; | ||
import path from 'path'; | ||
|
||
async function getRunningVersion() { | ||
const terminalCmd = 'node --version'; | ||
|
||
try { | ||
return execSync(terminalCmd).toString().trim(); | ||
} catch (e) { | ||
console.log(chalk.red(`Node version validation failed while running ${terminalCmd}`), e); | ||
} | ||
} | ||
|
||
async function validateVersion() { | ||
const directory = path.resolve(); | ||
let runningVersion; | ||
|
||
try { | ||
const filePath = path.resolve(directory, '.nvmrc'); | ||
const fileMetadata = await fs.promises.stat(filePath); | ||
const fileContent = fs.readFileSync(filePath, "utf8"); | ||
let specVersion; | ||
|
||
if (fileMetadata) { | ||
specVersion = fileContent.startsWith("v") ? fileContent : `v${fileContent};` | ||
runningVersion = (await getRunningVersion()).trim(); | ||
|
||
if (runningVersion.trim() !== specVersion.trim()) { | ||
console.log(chalk.red(`Your Node version ${runningVersion} does not match the specified version ${specVersion} \rfound in the .nvmrc file in your project root`) ); | ||
console.log('\n-------------\n'); | ||
console.log(chalk.red('Run command "nvm use" followed by "npm ci" in your terminal before running "npm run start" again.\n')); | ||
process.exit(1); | ||
} | ||
} | ||
|
||
|
||
} catch (e) { | ||
if (e.code !== "ENOENT") { | ||
console.log(chalk.red('An unexpected error occurred while validating your Node version.\n')); | ||
console.error(e); | ||
process.exit(1); | ||
} | ||
console.log(chalk.red('Make sure the ".nvmrc" file from the Git repository is present in your project root directory\n')); | ||
console.error(e); | ||
process.exit(1); | ||
} | ||
} | ||
|
||
validateVersion(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.