{"id":25528794,"url":"https://github.com/felipefacundes/shell_markdown_reader","last_synced_at":"2026-01-12T22:30:18.942Z","repository":{"id":278296206,"uuid":"935152519","full_name":"felipefacundes/shell_markdown_reader","owner":"felipefacundes","description":"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. ","archived":false,"fork":false,"pushed_at":"2025-02-19T01:52:47.000Z","size":0,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-19T02:36:19.218Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://shellutils.github.io/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/felipefacundes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-19T01:44:44.000Z","updated_at":"2025-02-19T01:52:50.000Z","dependencies_parsed_at":"2025-02-19T02:46:31.145Z","dependency_job_id":null,"html_url":"https://github.com/felipefacundes/shell_markdown_reader","commit_stats":null,"previous_names":["felipefacundes/shell_markdown_reader"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefacundes%2Fshell_markdown_reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefacundes%2Fshell_markdown_reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefacundes%2Fshell_markdown_reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefacundes%2Fshell_markdown_reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/felipefacundes","download_url":"https://codeload.github.com/felipefacundes/shell_markdown_reader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239749273,"owners_count":19690416,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2025-02-19T23:23:05.967Z","updated_at":"2026-01-12T22:30:18.882Z","avatar_url":"https://github.com/felipefacundes.png","language":"Shell","readme":"# Shell Markdown Reader\n\nShell 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.\n\n## Features\n- **Multi-level headers** with distinct colors for better visibility.\n- **Syntax highlighting** for inline code and code blocks.\n- **Formatted lists**, including bullet points and numbered lists.\n- **Table rendering** with color differentiation for headers.\n- **Hyperlink processing**, displaying links in cyan for quick identification.\n- **Horizontal rule formatting** for improved readability.\n- **Automatic removal of unwanted HTML tags** such as `\u003cbr\u003e`, `\u003ccode\u003e`, and `\u003cpre\u003e`.\n- **Efficient processing of various Markdown syntaxes**.\n\n## Installation\nTo install Shell Markdown Reader, clone the repository using:\n\n```sh\ngit clone https://github.com/felipefacundes/shell_markdown_reader\ncd shell_markdown_reader\nchmod +x shell_markdown_reader.sh\n```\n\n## Usage\nRun the script with a Markdown file as an argument:\n\n```sh\n./shell_markdown_reader.sh README.md\n```\n\n### Options:\n- `-h`, `--help`: Show the help message.\n- `-nl`, `--no-less`: Disable pagination mode.\n- `-nh`, `--no-hl`: Disable syntax highlighting for code blocks.\n\nExample usage:\n\n```sh\n./shell_markdown_reader.sh --no-hl document.md\n```\n\n## Dependencies\nEnsure that the following dependencies are installed:\n- `source-highlight`\n- `less`\n\nIf they are missing, install them using:\n\n```sh\nsudo apt install source-highlight less  # For Debian-based systems\nsudo dnf install source-highlight less  # For Fedora-based systems\n```\n\n## Part of Shell Utils Framework\nShell 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).\n\n## License\nThis project is licensed under the **GPLv3 License**.\n\n## Author\nDeveloped by **Felipe Facundes**.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelipefacundes%2Fshell_markdown_reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffelipefacundes%2Fshell_markdown_reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelipefacundes%2Fshell_markdown_reader/lists"}