@shinagawa-web/gomarklint 2.7.0 → 2.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -0
- package/install.js +1 -1
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# gomarklint
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@shinagawa-web/gomarklint)
|
|
4
|
+
[](https://github.com/shinagawa-web/gomarklint/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
> A fast, opinionated Markdown linter. Built in Go, designed for CI.
|
|
7
|
+
|
|
8
|
+
- Catch broken links and headings before your docs ship.
|
|
9
|
+
- Enforce predictable structure (no more "why is this H4 under H2?").
|
|
10
|
+
- Output that's friendly for both humans and machines (JSON).
|
|
11
|
+
- Process **100,000+ lines in ~170ms** — fast enough for local dev, robust enough for CI.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm install -g @shinagawa-web/gomarklint
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The postinstall script automatically downloads the correct binary for your platform.
|
|
20
|
+
|
|
21
|
+
### Supported platforms
|
|
22
|
+
|
|
23
|
+
| OS | x64 | arm64 |
|
|
24
|
+
|---------|-----|-------|
|
|
25
|
+
| macOS | o | o |
|
|
26
|
+
| Linux | o | o |
|
|
27
|
+
| Windows | o | o |
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
# Lint all Markdown files in current directory
|
|
33
|
+
gomarklint
|
|
34
|
+
|
|
35
|
+
# Lint specific files
|
|
36
|
+
gomarklint README.md docs/**/*.md
|
|
37
|
+
|
|
38
|
+
# Output as JSON
|
|
39
|
+
gomarklint --format json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Documentation
|
|
43
|
+
|
|
44
|
+
Full documentation is available at **[shinagawa-web.github.io/gomarklint](https://shinagawa-web.github.io/gomarklint/)**
|
|
45
|
+
|
|
46
|
+
- [Quick Start](https://shinagawa-web.github.io/gomarklint/docs/quick-start/)
|
|
47
|
+
- [Rules](https://shinagawa-web.github.io/gomarklint/docs/rules/)
|
|
48
|
+
- [CLI Reference](https://shinagawa-web.github.io/gomarklint/docs/cli/)
|
|
49
|
+
- [Configuration](https://shinagawa-web.github.io/gomarklint/docs/configuration/)
|
|
50
|
+
- [GitHub Actions Integration](https://shinagawa-web.github.io/gomarklint/docs/github-actions/)
|
|
51
|
+
|
|
52
|
+
## Other installation methods
|
|
53
|
+
|
|
54
|
+
- **Shell:** `curl -fsSL https://raw.githubusercontent.com/shinagawa-web/gomarklint/main/install.sh | sh`
|
|
55
|
+
- **Homebrew:** `brew install shinagawa-web/tap/gomarklint`
|
|
56
|
+
- **Go:** `go install github.com/shinagawa-web/gomarklint@latest`
|
|
57
|
+
- **Binary:** Download from [GitHub Releases](https://github.com/shinagawa-web/gomarklint/releases/latest)
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
MIT License
|
package/install.js
CHANGED
|
@@ -87,7 +87,7 @@ async function main() {
|
|
|
87
87
|
|
|
88
88
|
// Download checksums and archive in parallel
|
|
89
89
|
const [checksumsText, archiveData] = await Promise.all([
|
|
90
|
-
download(`${baseUrl}/
|
|
90
|
+
download(`${baseUrl}/gomarklint_${version}_checksums.txt`).then((buf) => buf.toString("utf8")),
|
|
91
91
|
download(`${baseUrl}/${archiveName}`),
|
|
92
92
|
]);
|
|
93
93
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shinagawa-web/gomarklint",
|
|
3
|
-
"version": "2.7.
|
|
3
|
+
"version": "2.7.2",
|
|
4
4
|
"description": "A fast, extensible Markdown linter written in Go",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://github.com/shinagawa-web/gomarklint.git",
|
|
9
9
|
"directory": "npm"
|
|
10
10
|
},
|
|
11
|
-
"homepage": "https://
|
|
11
|
+
"homepage": "https://shinagawa-web.github.io/gomarklint/",
|
|
12
12
|
"keywords": [
|
|
13
13
|
"markdown",
|
|
14
14
|
"linter",
|
|
@@ -23,7 +23,8 @@
|
|
|
23
23
|
},
|
|
24
24
|
"files": [
|
|
25
25
|
"cli.js",
|
|
26
|
-
"install.js"
|
|
26
|
+
"install.js",
|
|
27
|
+
"README.md"
|
|
27
28
|
],
|
|
28
29
|
"engines": {
|
|
29
30
|
"node": ">=16"
|