Skip to content

Commit 5e9e0a0

Browse files
committed
👷 Add markdownlint pipeline
1 parent 312b4d7 commit 5e9e0a0

File tree

8 files changed

+192
-13
lines changed

8 files changed

+192
-13
lines changed

.github/workflows/node.js.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Node.js CI
2+
3+
on:
4+
push:
5+
branches: main
6+
pull_request:
7+
branches: main
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: pnpm/action-setup@v4
16+
with:
17+
version: latest
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: latest
21+
cache: pnpm
22+
- run: pnpm install --frozen-lockfile --strict-peer-dependencies
23+
- run: pnpm run build
24+
- run: pnpm run lint

.markdownlint-cli2.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
gitignore: true

.markdownlint.json

Lines changed: 0 additions & 9 deletions
This file was deleted.

.markdownlint.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
default: true
2+
line-length: false
3+
link-fragments: false
4+
no-duplicate-heading:
5+
siblings_only: true
6+
no-inline-html: false

.markdownlintrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
./docs/changelog.md

package.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "coderabbit-docs",
2+
"name": "@coderabbitai/coderabbit-docs",
33
"version": "0.0.0",
44
"private": true,
55
"scripts": {
@@ -10,9 +10,11 @@
1010
"deploy": "docusaurus deploy",
1111
"clear": "docusaurus clear",
1212
"serve": "docusaurus serve",
13+
"lint": "markdownlint-cli2 \"**/*.md\"",
14+
"lint:fix": "markdownlint-cli2 \"**/*.md\" --fix",
1315
"write-translations": "docusaurus write-translations",
1416
"write-heading-ids": "docusaurus write-heading-ids",
15-
"typecheck": "tsc"
17+
"typecheck": "tsc --noEmit"
1618
},
1719
"dependencies": {
1820
"@docusaurus/core": "^3.1.1",
@@ -32,14 +34,19 @@
3234
},
3335
"devDependencies": {
3436
"@docusaurus/module-type-aliases": "^3.1.1",
37+
"@docusaurus/theme-classic": "^3.5.2",
3538
"@docusaurus/tsconfig": "^3.1.1",
3639
"@docusaurus/types": "^3.1.1",
3740
"@types/js-yaml": "^4.0.9",
41+
"@types/node": "^22.8.4",
3842
"@types/react": "^18.3.4",
3943
"ace-builds": "^1.36.1",
4044
"ajv": "^8.17.1",
4145
"js-yaml": "^4.1.0",
46+
"markdownlint-cli2": "^0.14.0",
47+
"prettier": "^3.3.3",
4248
"react": "^18.3.1",
49+
"sitemap": "^8.0.0",
4350
"typescript": "~5.2.2"
4451
},
4552
"browserslist": {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy