Skip to content

muesli/marky

Repository files navigation

marky

Generate markdown programmatically

GoDoc Build Status Coverage Status Go ReportCard

Usage

d := NewDocument().
    Add(Heading{
        Caption: "This is marky",
        Level:   1,
    }).
    Add(NewParagraph().
        Add(Text{
            Text: "I really like using Markdown.",
        }),
    ).
    Add(NewParagraph().
        Add(Image{
            Text:  "An Image",
            Image: "/image.png",
        }),
    )

ioutil.WriteFile("README.md", []byte(d.String()), 0644)

Links

d.Add(Link{
    Text: "A Link",
    URL:  "https://a.url",
})

Images

d.Add(Image{
    Text:  "An Image",
    Image: "/image.png",
    URL: "https://a.url",
})

Quotes

e := Quote{}
e.Add(Text{
    Text: "Dorothy followed her through many of the beautiful rooms in her castle.",
})
d.Add(e)

Codeblocks

d.Add(Code{
    Source: `echo "Hello"\necho "World"`,
    Language: "bash",
})

Lists

e := List{
    Ordered: true,
}
e.Add(Text{
    Text: "First Item",
}).Add(Text{
    Text: "Second Item",
})
d.Add(e)

Tasks

e := List{}
e.Add(Task{
    Text: "First Task",
}).Add(Task{
    Text: "Second Task",
    Done: true,
})
d.Add(e)

About

Generate markdown programmatically

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages