umonolang

README

UmonoLang

A domain-specific language to provide Umono's users to create page contents.

Features

• CommonMark compatibility
• HTML output
• Components able to nested for reusability

package main

import (
	ul "github.com/umono-cms/umono-lang"
	"github.com/umono-cms/umono-lang/converters"
)

func main() {
	umonoLang := ul.New(converters.NewHTML())
	umonoLang.SetGlobalComponent("HEADER", "This is a *global* component example.")

	input := `HEADER

CONTENT

{{ LINK text="click me!" url="https://github.com/umono-cms/umono" new-tab=true }}

~ CONTENT
This is a **local** component example.`

  output := umonoLang.Convert(input)
  // <p>This is a <em>global</em> component example.</p><p>This is a <strong>local</strong> component example.</p><p><a href="https://github.com/umono-cms/umono" target="_blank" rel="noopener noreferrer">click me!</a></p>
}

Documentation

Index

• type Call
  • func NewCall(component interfaces.Component, start int, end int) *Call
  • func (c *Call) Component() interfaces.Component
  • func (c *Call) End() int
  • func (c *Call) ParameterByName(name string) interfaces.Parameter
  • func (c *Call) Parameters() []interfaces.Parameter
  • func (c *Call) Start() int
• type Parameter
  • func NewParam(name string, value any) *Parameter
  • func (p *Parameter) Name() string
  • func (p *Parameter) SetValue(val any)
  • func (p *Parameter) Value() any
• type UmonoLang
  • func New(converter interfaces.Converter) *UmonoLang
  • func (ul *UmonoLang) Convert(raw string) string
  • func (ul *UmonoLang) RemoveGlobalComponent(name string) error
  • func (ul *UmonoLang) SetGlobalComponent(name, content string) error

Types

type Call

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

func NewCall

func NewCall(component interfaces.Component, start int, end int) *Call

func (*Call) Component

func (c *Call) Component() interfaces.Component

func (*Call) End

func (c *Call) End() int

func (*Call) ParameterByName

func (c *Call) ParameterByName(name string) interfaces.Parameter

func (*Call) Parameters

func (c *Call) Parameters() []interfaces.Parameter

func (*Call) Start

func (c *Call) Start() int

type Parameter

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

func NewParam

func NewParam(name string, value any) *Parameter

func (*Parameter) Name

func (p *Parameter) Name() string

func (*Parameter) SetValue

func (p *Parameter) SetValue(val any)

func (*Parameter) Value

func (p *Parameter) Value() any

type UmonoLang

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

func New

func New(converter interfaces.Converter) *UmonoLang

func (*UmonoLang) Convert

func (ul *UmonoLang) Convert(raw string) string

func (*UmonoLang) RemoveGlobalComponent

func (ul *UmonoLang) RemoveGlobalComponent(name string) error

func (*UmonoLang) SetGlobalComponent

func (ul *UmonoLang) SetGlobalComponent(name, content string) error