Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d9092c9

Browse files
committedJul 16, 2023
docs: add website url, add icons to README
1 parent f67e2fe commit d9092c9

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed
 

‎README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,15 @@
55

66
An `eslint` plugin for checking accessibility rules from within `.vue` files.
77

8-
## Documentation
8+
## 📚 Documentation
99

10-
<!-- TODO: Docs URL -->
10+
Please refer to the [official website](https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/).
1111

12-
Please refer to the [official website]().
13-
14-
## Development
12+
## 💻 Development
1513

1614
Ensure you have `node` and `yarn` installed on your system. Then run `yarn` in the root of the repository to install the dependencies.
1715

18-
### Adding a new rule
16+
### 🔧 Adding a new rule
1917

2018
To add a new rule, you need to take the following steps:
2119

@@ -24,15 +22,15 @@ To add a new rule, you need to take the following steps:
2422
- Add the corresponding test in `src/rules/__tests__`.
2523
- Add the corresponding documentation in `docs/rules`.
2624

27-
## Contributing
25+
## 👨‍💻 Contributing
2826

2927
Bug reports and pull requests are welcome on GitHub at https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility.
3028

31-
## License
29+
## 📄 License
3230

3331
The code is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
3432

35-
## Credit
33+
## 🏆 Credit
3634

3735
The work for this plugin was largely based on previous work done on [eslint-plugin-vue-a11y](https://github.com/maranran/eslint-plugin-vue-a11y), as well as various other tools, including:
3836

‎src/utils/makeDocsURL.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
// TODO: Docs URL
21
function makeDocsURL(name: string) {
3-
return `https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility/blob/master/docs/${name}.md`;
2+
return `https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/rules/${name}.html`;
43
}
54

65
export default makeDocsURL;

0 commit comments

Comments
 (0)
Please sign in to comment.