Skip to content
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.

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

Minor docs fixes #1453

Merged
merged 2 commits into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"version": "0.2",
"words": [
"adcontainer",
"atitle",
"attrname",
"attrvalue",
"bgsound",
"blabla",
"blankspace",
"checkstyle",
"clsx",
"codecov",
"codeql",
"commitlint",
"enochian",
"extlang",
"guoyu",
"hjid",
"hjsv",
"Hotjar",
"htmlhint",
"htmlhintrc",
"htmlparser",
"Infima",
"invision",
"langtag",
"mingo",
"nocolor",
"nodir",
"nomix",
"onttt",
"opencollective",
"ruleid",
"rulesdir",
"ruleset",
"selfclosing",
"sometag",
"specialchars",
"stylelint",
"svgr",
"tagend",
"tagname",
"tagstart",
"testhref",
"testtitle",
"uffff",
"unmin",
"xiang",
"Yanis"
],
"language": "en,en-US",
"ignorePaths": [".cspell.json"],
"useGitignore": true
}
22 changes: 22 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: 'Check spelling'
on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
spellcheck:
runs-on: ubuntu-latest
if: ${{ github.actor != 'dependabot[bot]' }}
steps:
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v6
with:
check_dot_files: false
incremental_files_only: true
inline: warning
strict: false
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ lib-cov
.nyc_output
coverage

# Compiled binary addons (http://nodejs.org/api/addons.html)
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directory
Expand Down
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ CHANGELOG.md

# Report created by test
report.html

CODEOWNERS
File renamed without changes.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ First, thank you for considering contributing to HTMLHint! It's people like you
We welcome any type of contribution, not only code. You can help with

- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
- **Marketing**: writing blog posts, howto's, printing stickers, ...
- **Marketing**: writing blog posts, how-to's, printing stickers, ...
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
- **Code**: take a look at the [open issues](https://github.com/thedaviddias/HTMLHint/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.

Expand All @@ -26,7 +26,7 @@ It is also always helpful to have some context for your pull request. What was t

## Questions

If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
If you have any questions, create an [issue](issue) (ProTip: do a quick search first to see if someone else didn't ask the same question before!).
You can also reach us at [email protected].

<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->
2 changes: 1 addition & 1 deletion commitlint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module.exports = {
extends: ['@commitlint/config-conventional'],
parserPreset: './parser-preset',

// Add your own rules. See http://marionebl.github.io/commitlint
// Add your own rules. See https://marionebl.github.io/commitlint
rules: {
// Apply valid scopes and types
'scope-enum': [scopeValidationLevel, 'always', validScopes],
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/rules/href-abs-or-rel.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following pattern are **not** considered violations:

<!-- prettier-ignore -->
```html
abs: <a href="http://www.alibaba.com/">test1</a> <a href="https://www.alipay.com/">test2</a>
abs: <a href="https://www.htmlhint.com/">test1</a> <a href="https://www.github.com/">test2</a>
rel: <a href="test.html">test1</a> <a href="../test.html">test2</a>

```
4 changes: 2 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ const config = {
href: 'https://stackoverflow.com/questions/tagged/htmlhint',
},
{
label: 'Twitter',
href: 'https://twitter.com/HTMLHint',
label: 'X (Twitter)',
href: 'https://x.com/HTMLHint',
},
],
},
Expand Down
4 changes: 2 additions & 2 deletions website/static/img/site.webmanifest
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "",
"short_name": "",
"name": "HTMLHint",
"short_name": "HTMLHint",
"icons": [
{
"src": "/android-chrome-192x192.png",
Expand Down
Loading