Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(examples): add simple example that renders markdown from a pipe #319

Merged
merged 1 commit into from
Jul 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions examples/stdin-stdout/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package main

// A simple example that renders input through a pipe.
//
// Usage:
// echo "# Hello, world!" | go run main.go
//
// cat README.md | go run main.go
//
// go run main.go < README.md

import (
"fmt"
"io"
"os"

"github.com/charmbracelet/glamour"
)

const defaultWidth = 80

func main() {
// Read from stdin.
in, err := io.ReadAll(os.Stdin)
if err != nil {
fmt.Fprintf(os.Stderr, "Error reading stdin: %s\n", err)
}

// Create a new renderer.
r, err := glamour.NewTermRenderer(
glamour.WithAutoStyle(),
glamour.WithWordWrap(defaultWidth),
)
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating renderer: %s\n", err)
}

// Render markdown.
md, err := r.RenderBytes(in)
if err != nil {
fmt.Fprintf(os.Stderr, "Error rendering markdown: %s\n", err)
}

// Write markdown to stdout.
fmt.Fprintf(os.Stdout, "%s\n", md)
}