Update README.md to include ignore tips (#16)

* Update README.md to include ignore tips * Update README.md * Upgrade MegaLinter * Fix lint errors * Update README.md * Update README.md * Update CHANGELOG.md * Update README.md Fix typo in oxsecurity * Update CHANGELOG.md * changelog * Fix links * ml * markdown formatting --------- Co-authored-by: Nicolas Vuillamy <[email protected]> Co-authored-by: Nicolas Vuillamy <[email protected]>
nvuillam · Nov 25, 2023 · cc4c02e · cc4c02e
1 parent bb7d764
commit cc4c02e
Show file tree

Hide file tree

Showing 9 changed files with 854 additions and 715 deletions.
diff --git a/.github/workflows/deploy-PROD.yml b/.github/workflows/deploy-PROD.yml
@@ -13,6 +13,8 @@ on:
       - "README.md"
       - "CHANGELOG.mg"
 
+permissions: read-all
+
 ###############
 # Set the Job #
 ###############

diff --git a/.github/workflows/deploy-RELEASE.yml b/.github/workflows/deploy-RELEASE.yml
@@ -8,6 +8,8 @@ on:
     # Want to run the automation when a release is created
     types: ["created"]
 
+permissions: read-all
+
 ###############
 # Set the Job #
 ###############

diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml
@@ -9,6 +9,9 @@ on:
   pull_request:
     branches: [master, main]
 
+permissions: 
+  contents: write
+
 env: # Comment env block if you do not want to apply fixes
   # Apply linter fixes configuration
   APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
@@ -35,18 +38,18 @@ jobs:
       - name: Mega-Linter
         id: ml
         # You can override Mega-Linter flavor used to have faster performances
-        # More info at https://oxsecurity.github.io/megalinter/flavors/
-        uses: oxsecurity/megalinter/flavors/javascript@v6
+        # More info at https://megalinter.io/latest/flavors/
+        uses: oxsecurity/megalinter/flavors/javascript@v7
         env:
           # All available variables are described in documentation
-          # https://oxsecurity.github.io/megalinter/configuration/
+          # https://megalinter.io/latest/config-file/
           VALIDATE_ALL_CODEBASE: true # Set ${{ github.event_name == &#39;push&#39; &amp;&amp; github.ref == &#39;refs/heads/master&#39; }} to validate only diff with master branch
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
 
       # Upload Mega-Linter artifacts
       - name: Archive production artifacts
-        if: ${{ success() }} || ${{ failure() }}
+        if: success() || failure()
         uses: actions/upload-artifact@v2
         with:
           name: Mega-Linter reports

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,6 +2,8 @@ name: Test
 
 on: [push, pull_request]
 
+permissions: read-all
+
 jobs:
   test_linux:
     name: Test - Ubuntu Node 12

diff --git a/.mega-linter.yml b/.mega-linter.yml
@@ -1,13 +1,15 @@
 # Configuration file for Mega-Linter
-# See all available variables at https://oxsecurity.github.io/megalinter/configuration/ and in linters documentation
+# See all available variables at https://megalinter.io/latest/config-file/ and in linters documentation
 
 APPLY_FIXES: all # all, none, or list of linter keys
 DEFAULT_BRANCH: master # Usually master or main
 # ENABLE: # If you use ENABLE variable, all other languages/formats/tooling-formats will be disabled by default
 # ENABLE_LINTERS: # If you use ENABLE_LINTERS variable, all other linters will be disabled by default
 DISABLE_LINTERS:
-  - GIT_GIT_DIFF
+  - REPOSITORY_GIT_DIFF
   - JAVASCRIPT_STANDARD
+DISABLE_ERRORS_LINTERS:
+  - REPOSITORY_GITLEAKS
 JAVASCRIPT_DEFAULT_STYLE: prettier
 FILTER_REGEX_EXCLUDE: (test_files)
 SHOW_ELAPSED_TIME: true

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## [1.4.2] 2023-11-25
+
+- Upgrade dependencies
+- Doc
+  - Add table of contents
+  - Add explanation of how to disable and re-enable formatting
+- CI
+  - Upgrade MegaLinter to v7
+
 ## [1.4.0] 2022-07-25
 
 - Add --verbose mode

diff --git a/README.md b/README.md
@@ -16,6 +16,19 @@ Format markdown tables in files, using embedded [markdown-table-prettify](https:
 
 [![Banner](https://raw.githubusercontent.com/nvuillam/markdown-table-formatter/master/docs/assets/images/banner.jpg)](https://github.com/nvuillam/markdown-table-formatter#readme)
 
+## Table of contents
+
+- [Installation](#installation)
+  - [Local](#local)
+  - [Global](#global)
+- [Usage](#usage)
+  - [Options](#options)
+- [Examples](#examples)
+- [Continuous Integration](#Continuous-Integration)
+- [Ignoring Code Blocks](#Ignoring-Code-Blocks)
+- [Contribute](#contribute)
+- [Release notes](#release-notes)
+
 ## Installation
 
 ### Local
@@ -87,28 +100,20 @@ You can see **more examples in** [**test methods**](https://github.com/nvuillam/
 
 ## Continuous Integration
 
-You can automatically check markdown tables formatting and fix it using [Mega-Linter](https://github.com/nvuillam/mega-linter/), that embeds markdown-table-formatter out of the box
-
-## CONTRIBUTE
+You can automatically check markdown tables formatting and fix it using [MegaLinter](https://github.com/oxsecurity/megalinter/), that embeds markdown-table-formatter out of the box
 
-Contributions are very welcome !
-
-Please follow [Contribution instructions](https://github.com/nvuillam/markdown-table-formatter/blob/master/CONTRIBUTING.md)
+## Ignoring Code Blocks
 
-## RELEASE NOTES
+You may wish to ignore specific markdown content, especially when using with [Megalinter](https://github.com/oxsecurity/megalinter) or [terraform-docs](https://github.com/terraform-docs/terraform-docs)
 
-## [1.0.2] 2021-01-19
+To achieve this, place tags `<!-- markdown-table-prettify-ignore-start -->` and `<!-- markdown-table-prettify-ignore-end -->` around the content you want markdown-table-formatter to ignore.
 
-- Fix code coverage
+## Contribute
 
-## [1.0.1] 2021-01-13
-
-- First working version :)
-
-## [0.0.1] 2021-01-13
+Contributions are very welcome !
 
-- Initial version
+Please follow [Contribution instructions](https://github.com/nvuillam/markdown-table-formatter/blob/master/CONTRIBUTING.md)
 
-____
+## Release Notes
 
 See complete [CHANGELOG](https://github.com/nvuillam/markdown-table-formatter/blob/master/CHANGELOG.md)