Skip to content

docs: create vitepress site #848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 36 commits into from
Jul 17, 2023
Merged

docs: create vitepress site #848

merged 36 commits into from
Jul 17, 2023

Conversation

Lehoczky
Copy link
Contributor

@Lehoczky Lehoczky commented Jul 16, 2023 •
edited
Loading

Resolves #809

What has been done:

  • initialized vitepress with basic settings
  • enabled local search functionality
  • current version is read from the package.json and show in the navbar
  • created a table component which shows every rule and whether they are in the recommended config by reading src/configs/recommended.ts
  • markdown files in the docs/rules folder are automatically added to the sidebar with getRulesForSideBar() function (vitepress can't do this automatically, see Auto-sidebar mode vuejs/vitepress#1737)
  • added GH action to deploy docs when changes are pushed to master
  • reorganized rule specific docs:

Lehoczky and others added 30 commits July 16, 2023 15:48
@Lehoczky
docs: create vitepress site
0221d7a
@Lehoczky
docs: fix changelog url
32071cb
@Lehoczky
docs: fix editLink
30d1738
@Lehoczky
docs: shorten title
c178c79
@dependabot @Lehoczky
chore(deps-dev): bump @typescript-eslint/parser from 5.59.9 to 5.59.11
ee75d85 
Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 5.59.9 to 5.59.11.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.59.11/packages/parser)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/parser"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.2.5 to 20.3.0
0362911 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.2.5 to 20.3.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps): bump aria-query from 5.1.3 to 5.2.0
f11f720 
Bumps [aria-query](https://github.com/A11yance/aria-query) from 5.1.3 to 5.2.0.
- [Changelog](https://github.com/A11yance/aria-query/blob/main/CHANGELOG.md)
- [Commits](A11yance/aria-query@v5.1.3...v5.2.0)

---
updated-dependencies:
- dependency-name: aria-query
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps): bump vue-eslint-parser from 9.3.0 to 9.3.1
b1e2891 
Bumps [vue-eslint-parser](https://github.com/vuejs/vue-eslint-parser) from 9.3.0 to 9.3.1.
- [Release notes](https://github.com/vuejs/vue-eslint-parser/releases)
- [Commits](vuejs/vue-eslint-parser@v9.3.0...v9.3.1)

---
updated-dependencies:
- dependency-name: vue-eslint-parser
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump np from 8.0.2 to 8.0.4
f28edfd 
Bumps [np](https://github.com/sindresorhus/np) from 8.0.2 to 8.0.4.
- [Release notes](https://github.com/sindresorhus/np/releases)
- [Commits](sindresorhus/np@v8.0.2...v8.0.4)

---
updated-dependencies:
- dependency-name: np
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps): bump aria-query from 5.2.0 to 5.2.1
a47054a 
Bumps [aria-query](https://github.com/A11yance/aria-query) from 5.2.0 to 5.2.1.
- [Changelog](https://github.com/A11yance/aria-query/blob/main/CHANGELOG.md)
- [Commits](A11yance/aria-query@v5.2.0...v5.2.1)

---
updated-dependencies:
- dependency-name: aria-query
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.3.0 to 20.3.1
530c6dd 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.3.0 to 20.3.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump eslint from 8.42.0 to 8.43.0
98d4f9f 
Bumps [eslint](https://github.com/eslint/eslint) from 8.42.0 to 8.43.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.42.0...v8.43.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.3.1 to 20.3.2
3b5e47a 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.3.1 to 20.3.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps): bump aria-query from 5.2.1 to 5.3.0
3f9fc30 
Bumps [aria-query](https://github.com/A11yance/aria-query) from 5.2.1 to 5.3.0.
- [Changelog](https://github.com/A11yance/aria-query/blob/main/CHANGELOG.md)
- [Commits](A11yance/aria-query@v5.2.1...v5.3.0)

---
updated-dependencies:
- dependency-name: aria-query
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump typescript from 5.1.3 to 5.1.5
b308fcd 
Bumps [typescript](https://github.com/Microsoft/TypeScript) from 5.1.3 to 5.1.5.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](microsoft/TypeScript@v5.1.3...v5.1.5)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump typescript from 5.1.5 to 5.1.6
8268c57 
Bumps [typescript](https://github.com/Microsoft/TypeScript) from 5.1.5 to 5.1.6.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](https://github.com/Microsoft/TypeScript/commits)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.3.2 to 20.3.3
513144e 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.3.2 to 20.3.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump jest from 29.5.0 to 29.6.0
46720aa 
Bumps [jest](https://github.com/facebook/jest/tree/HEAD/packages/jest) from 29.5.0 to 29.6.0.
- [Release notes](https://github.com/facebook/jest/releases)
- [Changelog](https://github.com/jestjs/jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/jest/commits/v29.6.0/packages/jest)

---
updated-dependencies:
- dependency-name: jest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump ts-jest from 29.1.0 to 29.1.1
fe4e7cd 
Bumps [ts-jest](https://github.com/kulshekhar/ts-jest) from 29.1.0 to 29.1.1.
- [Release notes](https://github.com/kulshekhar/ts-jest/releases)
- [Changelog](https://github.com/kulshekhar/ts-jest/blob/main/CHANGELOG.md)
- [Commits](kulshekhar/ts-jest@v29.1.0...v29.1.1)

---
updated-dependencies:
- dependency-name: ts-jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump prettier from 2.8.8 to 3.0.0
042c208 
Bumps [prettier](https://github.com/prettier/prettier) from 2.8.8 to 3.0.0.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/prettier@2.8.8...3.0.0)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.3.3 to 20.4.0
da8a0f7 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.3.3 to 20.4.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump jest from 29.6.0 to 29.6.1
e9a0c9f 
Bumps [jest](https://github.com/facebook/jest/tree/HEAD/packages/jest) from 29.6.0 to 29.6.1.
- [Release notes](https://github.com/facebook/jest/releases)
- [Changelog](https://github.com/jestjs/jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/facebook/jest/commits/v29.6.1/packages/jest)

---
updated-dependencies:
- dependency-name: jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.4.0 to 20.4.1
bd80809 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.4.0 to 20.4.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/jest from 29.5.2 to 29.5.3
f11efd7 
Bumps [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest) from 29.5.2 to 29.5.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jest)

---
updated-dependencies:
- dependency-name: "@types/jest"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps): bump semver from 6.3.0 to 6.3.1
dd3b15d 
Bumps [semver](https://github.com/npm/node-semver) from 6.3.0 to 6.3.1.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v6.3.1/CHANGELOG.md)
- [Commits](npm/node-semver@v6.3.0...v6.3.1)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Lehoczky
chore(deps-dev): bump @types/node from 20.4.1 to 20.4.2
badc841 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.4.1 to 20.4.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@Lehoczky
chore: update vitepress
68d93f8
@Lehoczky
refactor(docs): use description from package.json
f67e2fe
@Lehoczky
docs: add website url, add icons to README
d9092c9
@Lehoczky
ci: setup documentation deployment
d1fd013
@Lehoczky Lehoczky mentioned this pull request Jul 16, 2023
Closed
@Lehoczky
Copy link
Contributor Author

I don't know about the failing test for no-redundant-roles, it shouldn't be affected by these changes, should it?

@vhoyer
Copy link
Collaborator

vhoyer commented Jul 16, 2023

it shouldn't, no

@Lehoczky
Copy link
Contributor Author

It breaks with aria-query version 5.2 and above. Pinning it at ~5.1.0 makes the test pass, but I'm looking into fixing it without the downgrade.

@Lehoczky
Copy link
Contributor Author

I dug deeper and didn't find an easy solution, we should tackle this issue separately I think.

This breaking update probably wasn't noticed because the CI was already failing for some time caused by the old node version I now updated. See: https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility/actions/runs/5249674298/jobs/9482736540

@vhoyer
Copy link
Collaborator

vhoyer commented Jul 16, 2023 •
edited
Loading

Yeah, thanks for the help in debugging it, I should have it fixed now, mind updating the fork? (let's hope it doesn't close this PR too 😆)

@Lehoczky
Copy link
Contributor Author

Yeah, thanks for the help in debugging it, I should have it fixed now, mind updating the fork? (let's hope it doesn't close this PR too 😆)

Done 👍 I've reverted the aria-query downgrade as well

@vhoyer vhoyer merged commit 7257b3e into vue-a11y:main Jul 17, 2023
@vhoyer
Copy link
Collaborator

vhoyer commented Jul 17, 2023

thanks for the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vhoyer vhoyer vhoyer left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation website
2 participants
@Lehoczky @vhoyer