https://github.com/herbygillot/markstruct

Go package that converts string fields within a struct from Markdown to HTML in-place.
https://github.com/herbygillot/markstruct

Last synced: about 1 month ago
JSON representation

Go package that converts string fields within a struct from Markdown to HTML in-place.

• Host: GitHub
• URL: https://github.com/herbygillot/markstruct
• Owner: herbygillot
• License: mit
• Created: 2022-03-07T16:20:14.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-05-28T15:22:21.000Z (over 2 years ago)
• Last Synced: 2024-06-20T17:47:12.733Z (5 months ago)
• Language: Go
• Size: 27.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# markstruct ![Tests](https://github.com/herbygillot/markstruct/actions/workflows/test.yml/badge.svg?branch=master) [![Docs](https://godoc.org/github.com/herbygillot/markstruct?status.svg=)](https://pkg.go.dev/github.com/herbygillot/markstruct) [![Coverage Status](https://coveralls.io/repos/github/herbygillot/markstruct/badge.svg?branch=master)](https://coveralls.io/github/herbygillot/markstruct?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/herbygillot/markstruct)](https://goreportcard.com/report/github.com/herbygillot/markstruct)

> markstruct converts a struct's string fields from Markdown to HTML in-place.

`markstruct` scans a struct for tagged fields of relevant type (`string`, `*string`, `[]string` & maps with `string` values), and renders the field value from Markdown to HTML in-place. That is to say the value of each field itself will be changed within the struct to be the HTML result of rendering the original value as Markdown.

`markstruct` uses `github.com/yuin/goldmark` to render Markdown, and allows for

 custom `goldmark.Markdown` objects and parse options.

 ## Installation

 ```bash

 go get github.com/herbygillot/markstruct

 ```

 ## Usage

 `ConvertFields` accepts a pointer to struct, and converts fields of relevant type (as listed above) from Markdown to HTML that are tagged with `markdown:"on"`:

 ```

 type Document struct {

   Title string                 // this field will be ignored

   Body  string `markdown:"on"` // this field will be converted

 }

  doc := &Document{

	  Title: "Doc *1*",

	  Body:  "This is _emphasis_.",

  }

  changed, err := markstruct.ConvertFields(doc)

  ...

  fmt.Println(doc.Title) // "Doc *1*"

  fmt.Println(doc.Body)  // "
This is emphasis.
"


 ```

 `ConvertAllFields` also accepts a pointer to struct, but will convert **all** fields of relevant type, ignoring the absence or presence of the `markdown:"on"` tag.

 ```

 type Document struct {

   Title string                 // normally ignored, but will be converted by ConvertAllFields

   Body  string `markdown:"on"` // this field will be converted

 }

  doc := &Document{

	  Title: "Doc *1*",

	  Body:  "This is _emphasis_.",

  }

  changed, err := markstruct.ConvertAllFields(doc)

  ...

  fmt.Println(doc.Title) // "
Doc 1
"

  fmt.Println(doc.Body)  // "
This is emphasis.
"

  ```


There are equivalent functions, `ValidateFields` and `ValidateAllFields`, that can be used to check if errors would occur during conversion, making no changes to the target struct. They return the exact same values as `ConverFields` and `ConvertAllFields`, respectively.