Render markdown on the CLI
GitHub RepoImpressions225

Render markdown on the CLI

@the_ospsPost Author

Project Description

View on GitHub

Render Markdown Right in Your Terminal with Glow

Ever found yourself squinting at a raw README.md file in your terminal, trying to parse the asterisks and underscores into something readable? Or maybe you needed to quickly check some documentation without leaving the cozy confines of your command line. We've all been there. What if you could render that Markdown beautifully, right where you are?

Enter Glow, a command-line tool from Charmbracelet that styles your Markdown files with syntax highlighting, a clean layout, and even a dash of pizzazz. It turns your terminal into a proper Markdown viewer.

What It Does

Glow is a terminal-based Markdown reader. You simply point it at a Markdown file, a local directory, or even a GitHub URL, and it renders the formatted output directly in your terminal. It’s like having a dedicated preview pane for your docs, but without ever needing to switch to a browser or a GUI application.

Why It's Cool

Beyond just making your local files look good, Glow has a few tricks up its sleeve that make it genuinely useful.

  • It's Pager-Aware: It works seamlessly with your preferred pager (like less), so you can scroll through long documents easily.
  • GitHub and Git Support: You can point it directly at a GitHub repository (e.g., glow github.com/charmbracelet/glow) to read a remote README. It can also discover and display Markdown files in your local git repositories.
  • Styling Options: Don't like the default theme? Glow lets you specify a custom style. You can even "glow up" your markdown by piping content directly to it (cat README.md | glow -).
  • Offline-First: It works completely offline for local files, making it incredibly fast and reliable.

It’s one of those tools that feels obvious once you start using it. It doesn't try to do too much; it just does one thing and does it exceptionally well.

How to Try It

Getting started with Glow is straightforward. If you're on a Mac and use Homebrew, it's just one command away:

brew install glow

For other platforms like Linux or Windows (via Scoop), check out the comprehensive installation guide in the Glow GitHub repository. The repo has all the details you need.

Once installed, navigate to a project directory and run:

glow

It will present you with a list of discoverable Markdown files to choose from. To read a specific file:

glow README.md

That's it. Your Markdown is now rendered in all its terminal-friendly glory.

Final Thoughts

Glow is a perfect example of a simple utility that can quietly improve your daily workflow. It’s great for quickly skimming documentation, reviewing your own .md files before committing, or just making your terminal a slightly nicer place to work. It’s robust, fast, and gets out of your way. For developers who live in the terminal, it’s an easy recommendation.

Check out the project on GitHub to see all its features and give it a star if you find it useful.

Follow us for more cool projects: @githubprojects

Back to Projects
Project ID: 1964530471829942558Last updated: September 7, 2025 at 03:25 AM