From bf136dd7e61d0eadc7a75274e0015425b347aa09 Mon Sep 17 00:00:00 2001 From: Ceyhun Enki Aksan Date: Sun, 26 Mar 2023 19:23:28 +0300 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f31334e..b614d7a 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ -# markdown-linter \ No newline at end of file +# Markdown Linting Tool + +This is a repository for a Node.js script that scans directories and subdirectories for Markdown files and checks them for linting errors using the markdownlint package. The script supports custom configuration options for markdownlint and will only scan files that match a specific naming pattern. + +The script outputs a message indicating whether any linting errors were found and, if so, provides details on the specific errors, including the file, line number, and description of the issue. + +Use this script to quickly identify and correct linting errors in your Markdown files, ensuring consistency and readability across your documentation. + +### Installation +1. Clone the repository to your local machine. +2. Install the required packages by running the following command in your terminal: + +```bash +npm install +``` + +## Usage + +This is a simple command-line tool that uses the markdownlint library to scan a directory and its subdirectories for Markdown files that match a certain pattern (in this case, files named post.en.md and post.tr.md) and check them for any linting errors. + +1. Open markdown-lint.js in a text editor. +2. Edit the dirPath variable to point to the directory you want to scan. +3. (Optional) Edit the config object to specify your desired markdownlint configuration options. +4. Save the changes to markdown-lint.js. +5. Run the following command in your terminal: + +```bash +node markdown-lint.js +``` + +The script will scan the specified directory and output any linting errors it finds.