Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felipefacundes/shell_markdown_reader
This script is a Markdown reader that processes and displays the content of a Markdown file with syntax highlighting and color formatting in the terminal. It is designed to handle various Markdown elements, including headers, lists, blockquotes, inline code, code blocks, tables, hyperlinks, and horizontal rules.
https://github.com/felipefacundes/shell_markdown_reader
ebook ebook-reader ebooks markdown markdown-editor markdown-language markdown-reader markdown-renderer reader regex shell-script shell-scripting shell-scripts shellscript shellscripts syntax-highlighting
Last synced: 1 day ago
JSON representation
This script is a Markdown reader that processes and displays the content of a Markdown file with syntax highlighting and color formatting in the terminal. It is designed to handle various Markdown elements, including headers, lists, blockquotes, inline code, code blocks, tables, hyperlinks, and horizontal rules.
- Host: GitHub
- URL: https://github.com/felipefacundes/shell_markdown_reader
- Owner: felipefacundes
- License: gpl-3.0
- Created: 2025-02-19T01:44:44.000Z (3 days ago)
- Default Branch: main
- Last Pushed: 2025-02-19T01:52:47.000Z (3 days ago)
- Last Synced: 2025-02-19T02:36:19.218Z (2 days ago)
- Topics: ebook, ebook-reader, ebooks, markdown, markdown-editor, markdown-language, markdown-reader, markdown-renderer, reader, regex, shell-script, shell-scripting, shell-scripts, shellscript, shellscripts, syntax-highlighting
- Language: Shell
- Homepage: https://shellutils.github.io/
- Size: 0 Bytes
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shell Markdown Reader
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.
## Features
- **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 `
`, ``, and ``.
- **Efficient processing of various Markdown syntaxes**.
## Installation
To install Shell Markdown Reader, clone the repository using:
```sh
git clone https://github.com/felipefacundes/shell_markdown_reader
cd shell_markdown_reader
chmod +x shell_markdown_reader.sh
```
## Usage
Run the script with a Markdown file as an argument:
```sh
./shell_markdown_reader.sh README.md
```
### Options:
- `-h`, `--help`: Show the help message.
- `-nl`, `--no-less`: Disable pagination mode.
- `-nh`, `--no-hl`: Disable syntax highlighting for code blocks.
Example usage:
```sh
./shell_markdown_reader.sh --no-hl document.md
```
## Dependencies
Ensure that the following dependencies are installed:
- `source-highlight`
- `less`
If they are missing, install them using:
```sh
sudo apt install source-highlight less # For Debian-based systems
sudo dnf install source-highlight less # For Fedora-based systems
```
## Part of Shell Utils Framework
Shell Markdown Reader is also part of the **Shell Utils** framework, an extensive collection of scripts and utilities designed to simplify terminal workflows. You can explore more at [Shell Utils Repository](https://github.com/felipefacundes/shell_utils).
## License
This project is licensed under the **GPLv3 License**.
## Author
Developed by **Felipe Facundes**.