A simple, flexible, and easy-to-use library for creating markdown documents in gno.land

1. Bold Text

To make text bold, use the md.Bold() function:

This is bold text

2. Italic Text

To make text italic, use the md.Italic() function:

This is italic text

3. Strikethrough Text

To add strikethrough, use the md.Strikethrough() function:

This text is strikethrough

4. Headers (H1 to H6)

You can create headers (H1 to H6) using the md.H1() to md.H6() functions:

This is a level 1 header

This is a level 2 header

This is a level 3 header

This is a level 4 header

This is a level 5 header
This is a level 6 header

5. Bullet List

To create bullet lists, use the md.BulletList() function:

  • Item 1
  • Item 2
  • Item 3

6. Ordered List

To create ordered lists, use the md.OrderedList() function:

  1. First
  2. Second
  3. Third

7. Todo List

You can create a todo list using the md.TodoList() function, which supports checkboxes:

  • Task 1
  • Task 2

8. Blockquote

To create blockquotes, use the md.Blockquote() function:

This is a blockquote. It can span multiple lines.

9. Inline Code

To insert inline code, use the md.InlineCode() function:

fmt.Println() // inline code

10. Code Block

For multi-line code blocks, use the md.CodeBlock() function:

package main

func main() {
	// Your code here
}

11. Horizontal Rule

To add a horizontal rule (separator), use the md.HorizontalRule() function:


12. Language-specific Code Block

To create language-specific code blocks, use the md.LanguageCodeBlock() function:

1package main
2
3func main() {}

To create a hyperlink, use the md.Link() function:

Gnoland official docs

14. Image

To insert an image, use the md.Image() function:

Gnoland Logo

15. Footnote

To create footnotes, use the md.Footnote() function:

[1]: This is a footnote.

16. Table

To create a table, use the md.Table() function. Here's an example of a table:

Feature Description
Bold Make text bold using double asterisks
Italic Make text italic using single asterisks
Strikethrough Cross out text using double tildes

17. Escaping Markdown

Sometimes, you need to escape special Markdown characters (like *, _, and ). Use the md.EscapeMarkdown()` function for this:

Text Without Escape:

  • Escape special chars like *, _, and ` in markdown

Text With Escape:

- Escape special chars like *, _, and ` in markdown