https://github.com/a11ywatch/docs
A11yWatch documentation website
https://github.com/a11ywatch/docs
a11ywatch
Last synced: 9 days ago
JSON representation
A11yWatch documentation website
- Host: GitHub
- URL: https://github.com/a11ywatch/docs
- Owner: a11ywatch
- License: mit
- Created: 2021-01-30T18:04:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-28T16:43:36.000Z (over 1 year ago)
- Last Synced: 2025-03-29T10:43:40.086Z (30 days ago)
- Topics: a11ywatch
- Language: TypeScript
- Homepage: https://docs.a11ywatch.com
- Size: 716 KB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# docs
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
## Build
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER= USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.