converter

package
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2025 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Article

type Article struct {
	// Author is the author of the article.
	Author string `yaml:"author"`

	// Title is the title of the article.
	Title string `yaml:"title"`

	// Content is the content of the article.
	Content string `yaml:"-"`

	// Date is the date of the article.
	Date string `yaml:"date"`

	// Category is the category of the article.
	Category string `yaml:"categories"`

	// Tags is the tags of the article.
	Tags []string `yaml:"tags"`

	// Draft is the draft of the article.
	// If it is true, the article will not be published.
	Draft bool `yaml:"draft"`

	// ExtraFrontMatter is the extra front matter of the article.
	// It must be a valid YAML string.
	ExtraFrontMatter string `yaml:"-"`

	Key string `yaml:"-"`

	// Images is the images of the article.
	Images []*ImageDescriptor `yaml:"-"`
}

Article is the article for Hugo.

func (*Article) Export added in v0.6.0

func (article *Article) Export()

func (*Article) Transform added in v0.6.0

func (self *Article) Transform() (string, error)

Transform transforms the article to the markdown format.

type Converter

type Converter struct {
	*github.Client
	// contains filtered or unexported fields
}

func NewConverter

func NewConverter() *Converter

func (*Converter) GetIssues

func (c *Converter) GetIssues() []*github.Issue

func (*Converter) IssueToArticle

func (c *Converter) IssueToArticle(issue *github.Issue) *Article

IssueToArticle converts an issue into article. Returns an Article object and array of ImageDescriptor.

type ImageDescriptor

type ImageDescriptor struct {
	Url  string
	Time string
	Id   int
}

func (*ImageDescriptor) Save added in v0.6.0

func (self *ImageDescriptor) Save(path string, filename string)

Download downloads the image. Expected path is "path/to/image/".

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL