glow
Render markdown on the CLI, with pizzazz! ๐ ๐ป
File Explorer
Download Latest Version (.zip)- bug_report.md
- config.yml
- feature_request.md
- build.yml
- coverage.yml
- dependabot-sync.yml
- goreleaser.yml
- lint-sync.yml
- lint.yml
- dependabot.yml
- config.go
- editor.go
- ignore_darwin.go
- ignore_general.go
- keys.go
- markdown.go
- pager.go
- sort.go
- stash.go
- stashhelp.go
- stashitem.go
- styles.go
- ui.go
- utils.go
- .editorconfig
- .gitignore
- .golangci.yml
- .goreleaser.yml
- config_cmd.go
- console_windows.go
- Dockerfile
- example.png
- github.go
- gitlab.go
- glow_test.go
- go.mod
- go.sum
- LICENSE
- log.go
- main.go
- man_cmd.go
- README.md
- style.go
- Taskfile.yaml
- url.go
- url_test.go
๐ Installation Guide
1. Get the code
git clone https://github.com/charmbracelet/glow
Downloads the entire project code from GitHub to your computer.
cd glow
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
- Chocolatey A package manager for Windows.
- Scoop A package manager for Windows.
- Go Go is required to use go install.
brew install glow
Installs the pre-built package via Homebrew โ no source build required.
choco install glow
Installs directly via Chocolatey (Windows).
scoop install glow
Installs directly via Scoop (Windows).
go install charm.land/glow/v3@latest
Downloads and installs the specified version directly โ no need to clone the repo yourself.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t glow .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 glow
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Go
MediumPrerequisites
go install charm.land/glow/v3@latest
Downloads and installs the specified version directly โ no need to clone the repo yourself.
go build
Compiles the Go program into an executable.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)