Repository files navigation

Shell Markdown Reader is a powerful and enhanced Markdown reader designed for terminal users. This script processes and displays Markdown content with clean formatting, color highlights, and optional syntax highlighting for better readability. It is ideal for developers and content creators who prefer working in the terminal while maintaining structured and readable documentation.

• Multi-level headers with distinct colors for better visibility.
• Syntax highlighting for inline code and code blocks.
• Formatted lists, including bullet points and numbered lists.
• Table rendering with color differentiation for headers.
• Hyperlink processing, displaying links in cyan for quick identification.
• Horizontal rule formatting for improved readability.
• Automatic removal of unwanted HTML tags such as<br>,<code>, and<pre>.
• Efficient processing of various Markdown syntaxes.

To install Shell Markdown Reader, clone the repository using:

git clone https://github.com/felipefacundes/shell_markdown_readercd shell_markdown_readerchmod +x shell_markdown_reader.sh

Run the script with a Markdown file as an argument:

./shell_markdown_reader.sh README.md

• -h,--help: Show the help message.
• -nl,--no-less: Disable pagination mode.
• -nh,--no-hl: Disable syntax highlighting for code blocks.

Example usage:

./shell_markdown_reader.sh --no-hl document.md

Ensure that the following dependencies are installed:

• source-highlight
• less

If they are missing, install them using:

sudo apt install source-highlight less# For Debian-based systemssudo dnf install source-highlight less# For Fedora-based systems

Shell Markdown Reader is also part of theShell Utils framework, an extensive collection of scripts and utilities designed to simplify terminal workflows. You can explore more atShell Utils Repository.

This project is licensed under theGPLv3 License.

Developed byFelipe Facundes.