article

Documentation

Index

• func GetImageLinks(filename string) (map[string]string, error)
• func PrefixLinks(links map[string]string, prefix string, force bool) map[string]string
• func SetImageLinks(filename string, images map[string]string, prefix string) (string, error)
• type Client
  • func NewClient(apiKey string, opts ...Option) (*Client, error)
  • func (c *Client) GenerateImageLinks(filename, prefix string, override bool) error
  • func (c *Client) ListArticle(w io.Writer) error
  • func (c *Client) SubmitArticle(filename string, published bool, prefix string) error
• type FrontMatter
• type Option
  • func SetConfig(cfg configer) Option
• type Parsed
  • func Parse(filename string) (*Parsed, error)
  • func (p *Parsed) Content() (string, error)

Functions

func GetImageLinks

func GetImageLinks(filename string) (map[string]string, error)

func PrefixLinks

func PrefixLinks(links map[string]string, prefix string, force bool) map[string]string

func SetImageLinks

func SetImageLinks(filename string, images map[string]string, prefix string) (string, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiKey string, opts ...Option) (*Client, error)

func (*Client) GenerateImageLinks

func (c *Client) GenerateImageLinks(filename, prefix string, override bool) error

func (*Client) ListArticle

func (c *Client) ListArticle(w io.Writer) error

func (*Client) SubmitArticle

func (c *Client) SubmitArticle(filename string, published bool, prefix string) error

type FrontMatter

type FrontMatter struct {
	Title        string `yaml:"title,omitempty"`
	Published    *bool  `yaml:"published,omitempty"`
	Description  string `yaml:"description,omitempty"`
	Tags         string `yaml:"tags,omitempty"`
	CanonicalURL string `yaml:"canonical_url,omitempty" mapstructure:"canonical_url"`
	CoverImage   string `yaml:"cover_image,omitempty" mapstructure:"cover_image"`
	Series       string `yaml:"series,omitempty"`
}

FrontMatter as described in https://dev.to/p/editor_guide

type Option

type Option func(*Client)

func SetConfig

func SetConfig(cfg configer) Option

type Parsed

type Parsed struct {
	// contains filtered or unexported fields
}

func Parse

func Parse(filename string) (*Parsed, error)

Parse parses the article and divides the content into front matter and markdown. Heavily inspired by: https://github.com/gohugoio/hugo/blob/94cfdf6befd657e46c9458b23f17d851cd2f7037/commands/convert.go#L207-L250

func (*Parsed) Content

func (p *Parsed) Content() (string, error)

Content merges the front mattter and markdown source and returns it as string.