Git Product home page Git Product logo

wcag3-docs's Introduction

WCAG 3 docs wire frames

Installation

Prerequisites: This project requires NodeJS

From the repository root, run the following command to install all necessary dependencies:

npm ci

Local development

To run this project locally, use the following command in the repository's root directory. This will start a server on http://localhost:8080/. The server has hot-reload enabled so changes to files will be reflected in the browser immediately.

npm run serve

Creating a new outcome

  1. Copy _template/ in outcomes/. Use lower case letters and dashes (-) only for the directory name. This will be the slug which will be needed later.

  2. In your new directory, rename _template.11tydata.js to new-dir-name.11ty.data.js where new-dir-name is whatever you called the directory.

  3. in outcomes.json set the title to be the short name of the outcome. Examples: Non-text content, Error notification, etc. Add a 3 - 4 sentence description to description. The index is a number to help sort outcomes in order. Leave at 0 if you do not know what this should be.

  4. Fill out the .md files in your new directory

Create a new method

  1. Copy the method template from outcome/_template/methods/_template to the methods directory of the outcome you are creating a method for

  2. Give the copied directory an appropriate name

  3. Rename _template.json to match the directory name, and update its content. Give the method a title (1 - 4 words) and a description (2 - 4 sentences). The slug must be the directory name. Use index to sort methods.

  4. Fill out the .md files in your new directory

wcag3-docs's People

Contributors

wilcofiers avatar

Watchers

 avatar

Forkers

jspellman w3c

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.