Skip to content

Commit 7676bd4

Browse files
authored
Improve README (hestiacp#3109)
- Exclude test files from Prettier - Switch to faster/more official markdownlint CLI - Enable a couple Stylelint rules
1 parent bb6b893 commit 7676bd4

File tree

9 files changed

+201
-219
lines changed

9 files changed

+201
-219
lines changed

.github/workflows/lint.yml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,31 @@ on:
77
- main
88

99
jobs:
10-
shellcheck:
11-
name: ShellCheck
10+
markdownlint:
11+
name: markdownlint
1212
runs-on: ubuntu-latest
1313
steps:
1414
- name: Checkout code
1515
uses: actions/checkout@v3
1616

17-
- name: Run ShellCheck
18-
uses: ludeeus/action-shellcheck@6d3f514f44620b9d4488e380339edc0d9bbe2fba
17+
- name: Run markdownlint
18+
uses: DavidAnson/markdownlint-cli2-action@v8
1919
with:
20-
severity: error
20+
globs: |
21+
*.md
22+
docs/**/*.md
2123
22-
markdownlint:
23-
name: markdownlint
24+
shellcheck:
25+
name: ShellCheck
2426
runs-on: ubuntu-latest
2527
steps:
2628
- name: Checkout code
2729
uses: actions/checkout@v3
2830

29-
- name: Run markdownlint
30-
uses: avto-dev/markdown-lint@v1
31+
- name: Run ShellCheck
32+
uses: ludeeus/action-shellcheck@6d3f514f44620b9d4488e380339edc0d9bbe2fba
3133
with:
32-
args: "*.md docs/**/*.md"
34+
severity: error
3335

3436
prettier:
3537
name: Prettier

.lintstagedrc.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
// Run markdownlint on MD files
3-
'*.md': 'markdownlint --fix',
3+
'*.md': 'markdownlint-cli2-fix',
44
// Run Stylelint on CSS files
55
'*.css': 'stylelint --fix',
66
// Run ESLint on TS, TSX, JS, JSX files

.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
# Husky
1212
.husky/_/
1313

14+
# Exclude bats submodules if present
15+
/test/test_helper/*
16+
1417
# Bats seems to break Prettier
1518
*.bats
1619

.stylelintrc.cjs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ module.exports = {
44
'selector-class-pattern': null,
55
'no-descending-specificity': null,
66
'block-no-empty': null,
7-
8-
'max-line-length': null,
97
'declaration-block-no-shorthand-property-overrides': null,
10-
'selector-id-pattern': null,
118
},
129
};

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,37 @@
1-
# [Hestia Control Panel](https://www.hestiacp.com/)
1+
<h1 align="center"><a href="https://www.hestiacp.com/">Hestia Control Panel</a></h1>
22

33
![Hestia screenshot](https://hestiacp.com/img/screen_HestiaServer-dark.png)
44

5-
**Latest stable release:** Version 1.6.11 | [View Changelog](https://github.com/hestiacp/hestiacp/blob/release/CHANGELOG.md) | [![Build Status](https://drone.hestiacp.com/api/badges/hestiacp/hestiacp/status.svg?ref=refs/heads/main)](https://drone.hestiacp.com/hestiacp/hestiacp) <br>
5+
<h2 align="center">Lightweight and powerful control panel for the modern web.</h2>
6+
7+
<p align="center"><strong>Latest stable release:</strong> Version 1.6.11 | <a href="https://github.com/hestiacp/hestiacp/blob/release/CHANGELOG.md">View Changelog</a></p>
8+
9+
<p align="center">
10+
<a href="https://www.hestiacp.com/">HestiaCP.com</a> |
11+
<a href="https://docs.hestiacp.com/">Documentation</a> |
12+
<a href="https://forum.hestiacp.com/">Forum</a> |
13+
<a href="https://discord.gg/nXRUZch">Discord</a>
14+
<br/><br/>
15+
<a href="https://drone.hestiacp.com/hestiacp/hestiacp">
16+
<img src="https://drone.hestiacp.com/api/badges/hestiacp/hestiacp/status.svg?ref=refs/heads/main" alt="Drone Status"/>
17+
</a>
18+
<a href="https://github.com/hestiacp/hestiacp/actions/workflows/lint.yml">
19+
<img src="https://github.com/hestiacp/hestiacp/actions/workflows/lint.yml/badge.svg" alt="Lint Status"/>
20+
</a>
21+
</p>
22+
23+
## **Welcome!**
24+
25+
Hestia Control Panel is designed to provide administrators an easy to use web and command line interface, enabling them to quickly deploy and manage web domains, mail accounts, DNS zones, and databases from one central dashboard without the hassle of manually deploying and configuring individual components or services.
26+
27+
## Donate
628

7-
**Web:** [www.hestiacp.com](https://www.hestiacp.com/)<br>
8-
**Documentation:** [docs.hestiacp.com](https://docs.hestiacp.com/)<br>
9-
**Forums:** [forum.hestiacp.com](https://forum.hestiacp.com/)<br>
10-
**Discord:** [Join the discussion](https://discord.gg/nXRUZch)<br />
11-
<br>
1229
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA)<br /><br />
1330
Bitcoin : bc1q48jt5wg5jaj8g9zy7c3j03cv57j2m2u5anlutu<br>
1431
Ethereum : 0xfF3Dd2c889bd0Ff73d8085B84A314FC7c88e5D51<br>
1532
Binance: bnb1l4ywvw5ejfmsgjdcx8jn5lxj7zsun8ktfu7rh8<br>
1633
Smart Chain: 0xfF3Dd2c889bd0Ff73d8085B84A314FC7c88e5D51<br>
1734

18-
## **Welcome!**
19-
20-
Hestia Control Panel is designed to provide administrators an easy to use web and command line interface, enabling them to quickly deploy and manage web domains, mail accounts, DNS zones, and databases from one central dashboard without the hassle of manually deploying and configuring individual components or services.
21-
2235
## Features and Services
2336

2437
- Apache2 and NGINX with PHP-FPM

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"docs:build": "vitepress build docs",
1111
"docs:serve": "vitepress serve docs",
1212
"build": "postcss web/css/src/themes/*.css --dir web/css/themes --ext .min.css",
13-
"lint": "prettier --check . && eslint web/js/ && stylelint web/css/src/**/*.css && markdownlint *.md docs/**/*.md",
13+
"lint": "prettier --check . && eslint web/js/ && stylelint web/css/src/**/*.css && markdownlint-cli2 *.md docs/**/*.md",
1414
"lint-staged": "lint-staged",
1515
"format": "prettier --write .",
1616
"preinstall": "npx only-allow yarn",
@@ -30,8 +30,8 @@
3030
"eslint-config-prettier": "^8.5.0",
3131
"eslint-plugin-editorconfig": "^4.0.2",
3232
"husky": "^8.0.2",
33-
"lint-staged": "^13.0.4",
34-
"markdownlint-cli": "^0.32.2",
33+
"lint-staged": "^13.1.0",
34+
"markdownlint-cli2": "^0.5.1",
3535
"postcss": "^8.4.19",
3636
"postcss-cli": "^10.1.0",
3737
"postcss-import": "^15.0.1",

web/css/src/themes/default.css

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2124,11 +2124,6 @@
21242124
white-space: nowrap;
21252125
}
21262126

2127-
#v_password {
2128-
white-space: inherit;
2129-
word-break: break-word;
2130-
}
2131-
21322127
.additional-info {
21332128
margin-top: 12px;
21342129
width: 400px;

web/css/themes/default.min.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)