go-readability

(โ˜… 940)

Go package that cleans a HTML page for better readability.

  • .gitattributes
  • .gitignore
  • .travis.yml
  • go.mod
  • go.sum
  • LICENSE
  • Makefile
  • parser-check.go
  • parser-parse.go
  • parser.go
  • parser_test.go
  • readability.go
  • README.md
  • utils.go
  • utils_test.go

# Installation Guide

1. Get the code
git clone https://github.com/go-shiori/go-readability

Downloads the entire project code from GitHub to your computer.

cd go-readability

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Go Go is required to use go install.
go install github.com/go-shiori/go-readability/cmd/go-readability@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. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install github.com/go-shiori/go-readability/cmd/go-readability@latest

Downloads and installs the specified version directly โ€” no need to clone the repo yourself.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation