Skip to content

Commit

Permalink
Add pre-commit config to run awesome-lint
Browse files Browse the repository at this point in the history
  • Loading branch information
pengqun committed Feb 15, 2024
1 parent 94b00d9 commit 2087faa
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
pull_request:
push:
branches: [main]

jobs:
Awesome_Lint:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"default": true,
"MD013": false,
"MD024": false
}
}
13 changes: 13 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- repo: https://github.com/pengqun/pre-commit-hooks
rev: v1.1.0
hooks:
- id: awesome-lint
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!--
TODO:
- Script to add GitHub stars badge for repo link automatically
- Auto generate/update translated version of edits (VS Code plugin + ChatGPT?)
- Auto generate/update translated version of edits (VS Code plugin + ChatGPT?)
-->

# 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)
Expand Down
5 changes: 5 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
TODO:
- 自动翻译英文版变更内容,并同步到中文版
-->

# 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)

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

0 comments on commit 2087faa

Please sign in to comment.