Skip to content

Commit 2087faa

Browse files
committed
Add pre-commit config to run awesome-lint
1 parent 94b00d9 commit 2087faa

File tree

5 files changed

+21
-3
lines changed

5 files changed

+21
-3
lines changed

.github/workflows/action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
pull_request:
55
push:
66
branches: [main]
7-
7+
88
jobs:
99
Awesome_Lint:
1010
runs-on: ubuntu-latest

.markdownlint.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
"default": true,
33
"MD013": false,
44
"MD024": false
5-
}
5+
}

.pre-commit-config.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# See https://pre-commit.com/hooks.html for more hooks
2+
repos:
3+
- repo: https://github.com/pre-commit/pre-commit-hooks
4+
rev: v4.5.0
5+
hooks:
6+
- id: trailing-whitespace
7+
- id: end-of-file-fixer
8+
- id: check-yaml
9+
- id: check-added-large-files
10+
- repo: https://github.com/pengqun/pre-commit-hooks
11+
rev: v1.1.0
12+
hooks:
13+
- id: awesome-lint

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!--
33
TODO:
44
- Script to add GitHub stars badge for repo link automatically
5-
- Auto generate/update translated version of edits (VS Code plugin + ChatGPT?)
5+
- Auto generate/update translated version of edits (VS Code plugin + ChatGPT?)
66
-->
77

88
# Awesome Documentation [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [![Lint](https://github.com/pengqun/awesome-documentation/actions/workflows/action.yml/badge.svg)](https://github.com/pengqun/awesome-documentation/actions/workflows/action.yml)

README_zh.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
TODO:
3+
- 自动翻译英文版变更内容,并同步到中文版
4+
-->
5+
16
# Awesome Documentation [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [![Lint](https://github.com/pengqun/awesome-documentation/actions/workflows/action.yml/badge.svg)](https://github.com/pengqun/awesome-documentation/actions/workflows/action.yml)
27

38
> 一份关于软件文档模板、工具、指南和示例的精选资源列表(持续更新中)。

0 commit comments

Comments
 (0)