浏览代码

Add Markdown lint

baijunyao 3 年之前
父节点
当前提交
663f175111
共有 3 个文件被更改,包括 29 次插入5 次删除
  1. 11 0
      .github/workflows/CI.yml
  2. 6 0
      .markdownlint.yaml
  3. 12 5
      README.md

+ 11 - 0
.github/workflows/CI.yml

@@ -15,6 +15,17 @@ jobs:
           github_token: ${{ secrets.github_token }}
           dotenv_linter_flags: --skip UnorderedKey
 
+  markdown_lint:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Run markdownlint
+        uses: docker://avtodev/markdown-lint:v1
+        with:
+          args: './README.md'
+
   phpcs:
     name: PHPCS
     runs-on: ubuntu-latest

+ 6 - 0
.markdownlint.yaml

@@ -0,0 +1,6 @@
+no-inline-html: false
+first-header-h1: false
+required-headers: false
+first-line-heading: false
+line-length:
+  line_length: 800

+ 12 - 5
README.md

@@ -24,15 +24,19 @@
 ![laravel-bjyblog](./resources/readme/preview.jpg)
 
 ## Documentation
+
 [English](https://baijunyao.com/docs/laravel-bjyblog/en) [中文文档](https://baijunyao.com/docs/laravel-bjyblog)  
 
 ## Testing
-Run the tests with  
-```
+
+Run the tests with
+
+```bash
 ./vendor/bin/phpunit
 ```
 
 ## Example
+
 - [白俊遥博客](https://baijunyao.com)
 - [larwas](https://www.larwas.com)
 - [冯奎博客](https://fengkui.net)
@@ -54,9 +58,10 @@ Run the tests with
 Welcome to submit a PR or tell me to include your blog
 
 ## Links
-- Blog:[https://baijunyao.com](https://baijunyao.com)   
-- GitHub:[https://github.com/baijunyao/laravel-bjyblog](https://github.com/baijunyao/laravel-bjyblog)   
-- Gitee:[https://gitee.com/baijunyao/laravel-bjyblog](https://gitee.com/baijunyao/laravel-bjyblog)   
+
+- Blog:[https://baijunyao.com](https://baijunyao.com)
+- GitHub:[https://github.com/baijunyao/laravel-bjyblog](https://github.com/baijunyao/laravel-bjyblog)
+- Gitee:[https://gitee.com/baijunyao/laravel-bjyblog](https://gitee.com/baijunyao/laravel-bjyblog)
 
 ## Contributors
 
@@ -91,8 +96,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
 
 ## License
+
 laravel-bjyblog is open-sourced software licensed under the MIT license.
 
 ## Sponsors
+
 [![PHPStorm](./resources/readme/phpstorm.png)](https://www.jetbrains.com/phpstorm)
 [![Laravel-idea](./resources/readme/laravel-idea.png)](https://laravel-idea.com)