sisyphus

README

sisyphus

convert gemtext to html/markdown

(api, interfaces, cli tool - everything is likely to change drastically 😂

cli usage

create a markdown readme from gemtext:

$ sisyphus -f markdown <README.gmi >README.md

convert gemtext to html:

$ sisyphus <index.gmi >index.html

from go

// html
sisyphus.Cook(os.Stdin, os.Stdout, &sisyphus.Html{})

// markdown
sisyphus.Cook(os.Stdin, os.Stdout, &sisyphus.Markdown{})

// convert from a string
sisyphus.Convert("=> somewhere a link", &sisyphus.Html{})

// hooks
flavor := &sisyphus.Html{}
flavor.OnLink(".jpg", hook)

installation

go

go install blekksprut.net/sisyphus/cmd/sisyphus@latest

arch linux

sisyphus is available as a package in the AUR

it can be installed with an AUR helper (e.g. yay):

$ yay -S sisyphus

Documentation

Index

• Constants
• func Convert(gmi string, flavor Flavor) string
• func Cook(r io.Reader, w io.Writer, flavor Flavor)
• func Safe(raw string) string
• type Flavor
• type Hook
• type Html
  • func (html *Html) Aspeq(prefix string, useBase bool) LinkHook
  • func (html *Html) Close() string
  • func (html *Html) GetState() State
  • func (html *Html) Header(level int, text string) string
  • func (html *Html) Link(url string, text string) string
  • func (html *Html) ListItem(text string) string
  • func (html *Html) OnClose(hook Hook)
  • func (html *Html) OnLink(rule string, hook LinkHook)
  • func (html *Html) OnOpen(hook Hook)
  • func (html *Html) OnQuote(hook QuoteHook)
  • func (html *Html) Open() string
  • func (html *Html) Pre(text string) string
  • func (html *Html) Quote(text string) string
  • func (html *Html) SetState(state State) string
  • func (html *Html) Text(text string) string
  • func (html *Html) Wrap(tag string)
• type LinkHook
• type Markdown
  • func (md *Markdown) Aspeq(prefix string, useBase bool) LinkHook
  • func (md *Markdown) Close() string
  • func (md *Markdown) GetState() State
  • func (md *Markdown) Header(level int, text string) string
  • func (md *Markdown) Link(url string, text string) string
  • func (md *Markdown) ListItem(text string) string
  • func (md *Markdown) OnClose(hook Hook)
  • func (md *Markdown) OnLink(rule string, hook LinkHook)
  • func (md *Markdown) OnOpen(hook Hook)
  • func (md *Markdown) OnQuote(hook QuoteHook)
  • func (md *Markdown) Open() string
  • func (md *Markdown) Pre(text string) string
  • func (md *Markdown) Quote(text string) string
  • func (md *Markdown) SetState(state State) string
  • func (md *Markdown) Text(text string) string
  • func (md *Markdown) Wrap(s string)
• type QuoteHook
• type State

Constants

const Version = "0.4.5"

Functions

func Convert

func Convert(gmi string, flavor Flavor) string

func Cook

func Cook(r io.Reader, w io.Writer, flavor Flavor)

func Safe

func Safe(raw string) string

Types

type Flavor

type Flavor interface {
	Open() string
	Close() string
	ListItem(string) string
	Header(int, string) string
	Link(string, string) string
	Pre(string) string
	Quote(string) string
	Text(string) string

	SetState(State) string
	GetState() State

	OnLink(string, LinkHook)
	OnQuote(QuoteHook)
	OnOpen(Hook)
	OnClose(Hook)

	Aspeq(string, bool) LinkHook
	Wrap(string)
}

type Hook

type Hook func() string

type Html

type Html struct {
	Self      string
	State     State
	LinkHooks map[string]LinkHook
	QuoteHook QuoteHook
	OpenHook  Hook
	CloseHook Hook
	Greentext bool
}

func (*Html) Aspeq

func (html *Html) Aspeq(prefix string, useBase bool) LinkHook

func (*Html) Close

func (html *Html) Close() string

func (*Html) GetState

func (html *Html) GetState() State

func (*Html) Header

func (html *Html) Header(level int, text string) string

func (*Html) Link

func (html *Html) Link(url string, text string) string

func (*Html) ListItem

func (html *Html) ListItem(text string) string

func (*Html) OnClose

func (html *Html) OnClose(hook Hook)

func (*Html) OnLink

func (html *Html) OnLink(rule string, hook LinkHook)

func (*Html) OnOpen

func (html *Html) OnOpen(hook Hook)

func (*Html) OnQuote

func (html *Html) OnQuote(hook QuoteHook)

func (*Html) Open

func (html *Html) Open() string

func (*Html) Pre

func (html *Html) Pre(text string) string

func (*Html) Quote

func (html *Html) Quote(text string) string

func (*Html) SetState

func (html *Html) SetState(state State) string

func (*Html) Text

func (html *Html) Text(text string) string

func (*Html) Wrap

func (html *Html) Wrap(tag string)

type LinkHook

type LinkHook func(uri string, text string, match string) string

type Markdown

type Markdown struct {
	State State

	LinkHooks map[string]LinkHook
	QuoteHook QuoteHook
	OpenHook  Hook
	CloseHook Hook
}

func (*Markdown) Aspeq

func (md *Markdown) Aspeq(prefix string, useBase bool) LinkHook

func (*Markdown) Close

func (md *Markdown) Close() string

func (*Markdown) GetState

func (md *Markdown) GetState() State

func (*Markdown) Header

func (md *Markdown) Header(level int, text string) string

func (*Markdown) Link

func (md *Markdown) Link(url string, text string) string

func (*Markdown) ListItem

func (md *Markdown) ListItem(text string) string

func (*Markdown) OnClose

func (md *Markdown) OnClose(hook Hook)

func (*Markdown) OnLink

func (md *Markdown) OnLink(rule string, hook LinkHook)

func (*Markdown) OnOpen

func (md *Markdown) OnOpen(hook Hook)

func (*Markdown) OnQuote

func (md *Markdown) OnQuote(hook QuoteHook)

func (*Markdown) Open

func (md *Markdown) Open() string

func (*Markdown) Pre

func (md *Markdown) Pre(text string) string

func (*Markdown) Quote

func (md *Markdown) Quote(text string) string

func (*Markdown) SetState

func (md *Markdown) SetState(state State) string

func (*Markdown) Text

func (md *Markdown) Text(text string) string

func (*Markdown) Wrap

func (md *Markdown) Wrap(s string)

type QuoteHook

type QuoteHook func(text string) string

type State

type State int

const (
	None State = iota + 1
	Text
	List
	Pre
	Quote
)