Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/charmbracelet/glow
Render markdown on the CLI, with pizzazz! 💅🏻
https://github.com/charmbracelet/glow
cli excitement hacktoberfest markdown
Last synced: 13 days ago
JSON representation
Render markdown on the CLI, with pizzazz! 💅🏻
- Host: GitHub
- URL: https://github.com/charmbracelet/glow
- Owner: charmbracelet
- License: mit
- Created: 2019-11-04T23:34:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T19:04:46.000Z (about 2 months ago)
- Last Synced: 2024-08-26T15:21:27.003Z (about 1 month ago)
- Topics: cli, excitement, hacktoberfest, markdown
- Language: Go
- Homepage:
- Size: 2.63 MB
- Stars: 15,645
- Watchers: 77
- Forks: 334
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- orm-awesome - Glow
- awesomeLibrary - glow - Render markdown on the CLI, with pizzazz! 💅🏻 (语言资源库 / go)
- Self-Hosting-Guide - Glow
- awesome-tools - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Command Line / Dependency Management)
- awesome-cli-apps - glow - Styled markdown rendering. (Utilities / Markdown)
- awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/charmbracelet/glow - Markdown viewer (Jump To / CLI/TUI Apps)
- awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/charmbracelet/glow - Markdown viewer (Jump To / CLI/TUI Apps)
- awesome-starred-test - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- awesome-github-repos - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- project-awesome - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- awesome-repositories - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- vim-keybindings-everywhere-the-ultimate-list - glow - Terminal based markdown reader. (Misc)
- awesome-list - glow
- awesome-starts - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- go-awesome - glow - Terminal rendering displays markdown (Open source library / Command Line)
- awesome-cli-tui-software - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (<a name="data"></a>data)
- jimsghstars - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- awesome-devtools - Glow - A markdown renderer for the command line. (Command line - Linux / Learning resources)
- fucking-awesome-cli-apps - glow - Styled markdown rendering. (Utilities / Markdown)
- awesomeness - Glow - Render Markdown on the command line beautifully. (🛠️ Productivity / ☸️ Kubernetes)
- awesome-cli - glow - Render markdown on the CLI. (Lovely Commands)
- awesome-docs - Glow - Render Markdown on the CLI
- awesome-hacking-lists - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- awesome-starred - charmbracelet/glow - Render markdown on the CLI, with pizzazz! 💅🏻 (markdown)
- awesome-for-oneliner - glow - A command-line markdown viewer/renderer (Cat Replacement / Open USP Tsukubai)
- awesome-ops - charmbracelet/glow - 11-04|2024-10-01 | Glow 是一款基于终端的 Markdown 阅读器,从头开始设计,旨在展现 CLI 的美丽和强大功能。 | (终端命令行工具)
- charm-in-the-wild - Glow - A markdown reader, browser, and online markdown stash. (_built with Bubble Tea_) (Applications / Development Tools)
- StarryDivineSky - charmbracelet/glow
- my-awesome - charmbracelet/glow - 10 star:16.0k fork:0.3k Render markdown on the CLI, with pizzazz! 💅🏻 (Go)
- awesome-documentation - Glow - A terminal based markdown reader, which can be used to read documentation directly on the command line. (More Topics / Formats)
README
# Glow
Render markdown on the CLI, with _pizzazz_!
## What is it?
Glow is a terminal based markdown reader designed from the ground up to bring
out the beauty—and power—of the CLI.Use it to discover markdown files, read documentation directly on the command
line. Glow will find local markdown files in subdirectories or a local
Git repository.## Installation
### Package Manager
```bash
# macOS or Linux
brew install glow# macOS (with MacPorts)
sudo port install glow# Arch Linux (btw)
pacman -S glow# Void Linux
xbps-install -S glow# Nix shell
nix-shell -p glow --command glow# FreeBSD
pkg install glow# Solus
eopkg install glow# Windows (with Chocolatey, Scoop, or Winget)
choco install glow
scoop install glow
winget install charmbracelet.glow# Android (with termux)
pkg install glow# Debian/Ubuntu
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install glow# Fedora/RHEL
echo '[charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=1
gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
sudo yum install glow
```Or download a binary from the [releases][releases] page. MacOS, Linux, Windows,
FreeBSD and OpenBSD binaries are available, as well as Debian, RPM, and Alpine
packages. ARM builds are also available for macOS, Linux, FreeBSD and OpenBSD.### Go
Or just install it with `go`:
```bash
go install github.com/charmbracelet/glow@latest
```### Build (requires Go 1.21+)
```bash
git clone https://github.com/charmbracelet/glow.git
cd glow
go build
```[releases]: https://github.com/charmbracelet/glow/releases
## The TUI
Simply run `glow` without arguments to start the textual user interface and
browse local. Glow will find local markdown files in the
current directory and below or, if you’re in a Git repository, Glow will search
the repo.Markdown files can be read with Glow's high-performance pager. Most of the
keystrokes you know from `less` are the same, but you can press `?` to list
the hotkeys.## The CLI
In addition to a TUI, Glow has a CLI for working with Markdown. To format a
document use a markdown source as the primary argument:```bash
# Read from file
glow README.md# Read from stdin
echo "[Glow](https://github.com/charmbracelet/glow)" | glow -# Fetch README from GitHub / GitLab
glow github.com/charmbracelet/glow# Fetch markdown from HTTP
glow https://host.tld/file.md
```### Word Wrapping
The `-w` flag lets you set a maximum width at which the output will be wrapped:
```bash
glow -w 60
```### Paging
CLI output can be displayed in your preferred pager with the `-p` flag. This defaults
to the ANSI-aware `less -r` if `$PAGER` is not explicitly set.### Styles
You can choose a style with the `-s` flag. When no flag is provided `glow` tries
to detect your terminal's current background color and automatically picks
either the `dark` or the `light` style for you.```bash
glow -s [dark|light]
```Alternatively you can also supply a custom JSON stylesheet:
```bash
glow -s mystyle.json
```For additional usage details see:
```bash
glow --help
```Check out the [Glamour Style Section](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md)
to find more styles. Or [make your own](https://github.com/charmbracelet/glamour/tree/master/styles)!## The Config File
If you find yourself supplying the same flags to `glow` all the time, it's
probably a good idea to create a config file. Run `glow config`, which will open
it in your favorite $EDITOR. Alternatively you can manually put a file named
`glow.yml` in the default config path of you platform. If you're not sure where
that is, please refer to `glow --help`.Here's an example config:
```yaml
# style name or JSON path (default "auto")
style: "light"
# mouse wheel support (TUI-mode only)
mouse: true
# use pager to display markdown
pager: true
# at which column should we word wrap?
width: 80
```## Feedback
We’d love to hear your thoughts on this project. Feel free to drop us a note!
- [Twitter](https://twitter.com/charmcli)
- [The Fediverse](https://mastodon.social/@charmcli)
- [Discord](https://charm.sh/chat)## License
[MIT](https://github.com/charmbracelet/glow/raw/master/LICENSE)
---
Part of [Charm](https://charm.sh).
Charm热爱开源 • Charm loves open source