tagify

README

Tagify

Tagify can recieve STDIN, file or HTTP address as an input and return a list of most popular words ordered by popularity as an output.

More info about what is "Tagify" and the reasons behind it can be found here.

Supported formats:

• Plain text
• HTML
• Markdown

Supported languages:

• English
• Russian
• Chinese
• Hindi
• Hebrew
• Spanish
• Arabic
• Japanese
• German
• French
• Korean

Want to see it in action? Visit Tagify Playground.

Example, "tagify" this repository (with the limit of 5 tags):

tagify -s https://github.com/zoomio/tagify -l 5

In a code (see cmd/cli/cli.go).

Use -no-stop flag to disable filtering out of the stop-words.

Extensions (Beta)

Since v0.50.0 Tagify has added support for extensions. See extension/extension.go and its usages and implementations in processor/html/extension.go. You can see an example at processor/html/extension_test.go.

Installation

Binary

Get the latest release by running this command in your shell:

For MacOS:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" -o darwin

For MacOS (arm64):

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" -o darwin arm64

For Linux:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" -o linux

For Windows:

I didn't have time to automate Windows installation, but there is a binary for Windows platform too in the releases. So feel free to download it and install your own way.

PRs are also welcomed :)

Go dependency

go get -u github.com/zoomio/tagify/...

Changelog

See CHANGELOG.md

Contributing

See CONTRIBUTING.md

License

Released under the Apache License 2.0.

Documentation

Index

• Variables
• func Run(ctx context.Context, options ...Option) (*model.Result, error)
• type Config
• type ContentType
• type Option

Variables

var (
	Source   = config.Source
	Language = config.Language
	Content  = config.Content

	// headless
	Query      = config.Query
	WaitFor    = config.WaitFor
	WaitUntil  = config.WaitUntil
	Screenshot = config.Screenshot

	// misc
	TargetType  = config.TargetType
	Limit       = config.Limit
	Verbose     = config.Verbose
	NoStopWords = config.NoStopWords
	StopWords   = config.StopWords
	ContentOnly = config.ContentOnly
	FullSite    = config.FullSite

	// weighing
	TagWeightsString      = config.TagWeightsString
	TagWeightsJSON        = config.TagWeightsJSON
	ExtraTagWeightsString = config.ExtraTagWeightsString
	ExtraTagWeightsJSON   = config.ExtraTagWeightsJSON
	ExcludeTagsString     = config.ExcludeTagsString
	AllTagWeights         = config.AllTagWeights
	AdjustScores          = config.AdjustScores

	// content types
	Unknown       = config.Unknown
	Text          = config.Text
	HTML          = config.HTML
	Markdown      = config.Markdown
	ContentTypeOf = config.ContentTypeOf

	Extensions = config.Extensions
)

Functions

func Run

func Run(ctx context.Context, options ...Option) (*model.Result, error)

Run produces slice of tags ordered by frequency.

Types

type Config

type Config = config.Config

backwards compatibility

type ContentType

type ContentType = config.ContentType

type Option

type Option = config.Option