Skip to content

wpaccessibility/wp-a11y-docs

Repository files navigation

WordPress Accessibility Knowledge Base

Website: wpaccessibility.org.

Please note: wpaccessibility.org is a work in progress and is still in the setup phase. The knowledge base has no content yet and the site needs an accessibility audit. Please visit, for now, the documentation on the Make WordPress Accessible Handbook.

This website aims to provide you with answers about WordPress and accessibility. How do you design and create an accessible website or plugin? How do you write accessible content? What do you need to know to comply with international legislation?

We'll provide documentation, effective examples (both what to do and what to avoid) and reliable, up-to-date resources.

Additionally, we are developing a pattern library with code examples. We aim to meet WCAG 2.2 AA.

Did we miss a topic? Did you find an error or have a great idea? Create an issue on our GitHub repository wpaccessibility/wp-a11y-docs.

We would like to invite you to contribute to this Knowledge Base.

Pull Request Previews

When you create a pull request, a preview of your changes will be automatically deployed and a comment will be added to your PR with a link to the preview site. This allows you and reviewers to see how your changes will look before merging.

Preview URLs follow the format: https://wpaccessibility.org/pr-preview/pr-{number}/

Local install of the website

WPaccessibility.org is written in Jekyll, a static site generator in Ruby using markdown for content. Please read the Guide and requirements for Jekyll.

Then, in the terminal, install Jekyll:

gem install jekyll

Clone the wp-a11y-docs repository into your preferred directory and in that directory run:

npm install
bundle
bundle exec jekyll serve 

Open http://127.0.0.1:4000/ or http://localhost:4000 in your favourite browser.

Before making a commit or pull request, run the linters with: npm run test.

If you made changes to the _config.yml file, run bundle exec jekyll serve again to apply the changes to the site.

Documentation about Jekyll itself is on jekyllrb.com. The theme is based on the Jekyll theme Just the Docs. The changes made in Just the Docs are documented in the Changelog for Release v0.1.

About

Documentation to help WordPress creators and users create accessible work.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8