Merge pull request #2 from angolaosc/table

setup github action for linting and formatting
angolaosc · Jun 26, 2024 · d9b15d5 · d9b15d5
2 parents 82d0593 + 05a1bd5
commit d9b15d5
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 32 deletions.
diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml
@@ -0,0 +1,26 @@
+name: Linting and formatting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint-and-format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          npm install -g markdownlint-cli prettier
+
+      - name: Format README markdown file
+        run: prettier --write README.md
+
+      - name: Lint README markdown file
+        run: markdownlint README.md
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,24 @@
+{
+    "default": true,
+    "MD024": false,
+    "MD033": false,
+    "MD041": false,
+    "MD013": {
+      "line_length": 150,
+      "tables": true,
+      "code_blocks": false
+    },
+    "MD044": {
+      "names": false,
+      "maximum_length": 100
+    },
+    "MD025": {
+      "level": 2,
+      "front_matter_title": ""
+    },
+    "no-trailing-spaces": true,
+    "no-multiple-blanks": true,
+    "no-extra-punctuation": true,
+    "no-hard-tabs": true
+  }
+
diff --git a/README.md b/README.md
@@ -1,80 +1,105 @@
 # AOSC - ABA
 
-aba (Awesome Blogs by Angolans) a curated list of tech Blogs, YouTube Channels, Newsletter and many more, made by angolan developers and enthusiasts. The term "aba(in portuguese)", is literally translated to 'tab' in browsers, making it a fitting name for our project.
+aba (Awesome Blogs by Angolans) a curated list of tech Blogs, YouTube Channels, Newsletter and many more, made by angolan developers and enthusiasts.
 
-The list is divided into categories, and each category is sorted alphabetically. The list is updated regularly, and we welcome contributions to the list.
+The term "aba(in portuguese)", is literally translated to 'tab' in browsers, making it a fitting name for our project.
+
+The list is divided into categories, and each category is sorted alphabetically.
+The list is updated regularly, and we welcome contributions to the list.
 
 ## Adding a new 'aba'
 
 To add a new 'aba' to the list, you can either open a pull request or create an issue with the following information:
 
-### Format
 ```markdown
 | Name | Author | Topics separated by commas | [Link](https://example.com) |
 ```
+
 ## Abas
+
 ### Table of Contents
+
 - [Blogs](#blogs)
   - [A](#a)
   - [B](#b)
   - [C](#c)
 - [YouTube Channels](#youtube-channels)
-    - [A](#a-1)
-    - [B](#b-1)
+  - [A](#a-1)
+  - [B](#b-1)
 - [Newsletters](#newsletters)
-    - [A](#a-2)
-    - [B](#b-2)
+  - [A](#a-2)
+  - [B](#b-2)
 - [Podcasts](#podcasts)
-    - [A](#a-3)
-    - [B](#b-3)
+  - [A](#a-3)
+  - [B](#b-3)
 - [Forums](#forums)
-    
+
 ### Blogs
+
 #### A
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
-|AOSC Blog  | @angolaosc   | Open Source, Linux, Community | [Link](https://aosc.io/blog) |
+
+| Name      | Author     | Topics                        | Link                         |
+| --------- | ---------- | ----------------------------- | ---------------------------- |
+| AOSC Blog | @angolaosc | Open Source, Linux, Community | [Link](https://aosc.io/blog) |
 
 #### B
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 #### C
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 ### YouTube Channels
+
 #### A
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
-|AOSC Channel| @angolaosc   | Open Source, Linux, Community | [Link](https://www.youtube.com/channel/UC9Q6Jj5Z2Y1J1J5J2Z9J9JQ) |
-|Antonio Developer | @antoniodeveloper | Web Development, JavaScript, React | [Link](https://antoniodeveloper.com) |
+
+| Name              | Author            | Topics                             | Link                                                             |
+| ----------------- | ----------------- | ---------------------------------- | ---------------------------------------------------------------- |
+| AOSC Channel      | @angolaosc        | Open Source, Linux, Community      | [Link](https://www.youtube.com/channel/UC9Q6Jj5Z2Y1J1J5J2Z9J9JQ) |
+| Antonio Developer | @antoniodeveloper | Web Development, JavaScript, React | [Link](https://antoniodeveloper.com)                             |
 
 #### B
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 ### Newsletters
+
 #### A
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 #### B
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 ### Podcasts
+
 #### A
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 #### B
-| Name      | Author       | Topics                        | Link                         |
-|-----------|--------------|-------------------------------|------------------------------|
+
+| Name | Author | Topics | Link |
+| ---- | ------ | ------ | ---- |
 
 ### Forums
 
 ## License
+
+---------------|------------------------------|
+
+### Forums
+
+## License
+
 ABA is licensed under the [Apache License](./LICENSE), Version 2.0
 
 ---
@@ -85,4 +110,5 @@ aba is a <a href="http://github.com/angolasc">Angola Open-source Community</a> o
 
 ## Code of Conduct (CoC)
 
-Please note that ABA follows the [AOSC Code of Conduct](https://github.com/angolaosc/.github/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to follow its terms.
+Please note that ABA follows the [AOSC Code of Conduct](https://github.com/angolaosc/.github/blob/main/CODE_OF_CONDUCT.md).
+By participating in this project, you agree to follow its terms.