renderinghtml

README

Rendering HTML

From Markdown to HTML

With syntax highlighting 🎨

func h(w http.ResponseWriter, r *http.Request) {
  title := "It works! 👷"
  md := []byte("# It works!\n```go\nvar k = 4\nprintln(k)\n```\n")
  err := renderinghtml.Markdown2HTMLPage(w, md, title)
  if err != nil {
    slog.Error("render", "err", err)
    w.WriteHeader(http.StatusInternalServerError)
    return
  }
}

If you are seeing this in your web browser, try visiting the test page.

---

Screenshot

Features

• Markdown Rendering
• Syntax Highlighting
• Minify CSS/JS/HTML

Code

echo "hello world"

package main
import "fmt"
func main() {
    fmt.Println("hello world")
}

console.log("hello world");

#include <stdio.h>
int main() {
    printf("hello world\n");
    return 0;
}

SELECT * FROM users WHERE id = 1;

Commands

Included is a basic markdown2html command

markdown2html README.md
# Outputs:
# /tmp/markdown2html_README.html

# open browser
xdg-open file:///$(markdown2html README.md)

Documentation

Index

• Variables
• func CompilePage(out io.Writer, title, css, content string, headtags []string) error
• func Easy(title, content string) string
• func Markdown2HTMLPage(out io.Writer, in []byte, title string) error
• func Minifier(ct string, in string) string
• func MinifierStream(mediatype string, out io.Writer, in io.Reader) (n int64, err error)
• func MinifyHTML2(s string) (string, error)
• type Options
  • func Cfg() *Options
  • func New(title string) Options
  • func (o *Options) Init()
  • func (o Options) Markdown2HTML(out io.Writer, in []byte) error
  • func (o Options) Markdown2HTMLString(in []byte) (string, error)
• type Page

Variables

var (
	DefaultTheme       = "tokyonight-night"
	DefaultClassPrefix = "u-" // Injected into "./default.template.html" as {{.ClassPrefix}}
)

var (
	MinifyCSS  = minify.CSS
	MinifyJS   = minify.JS
	MinifySVG  = minify.SVG
	MinifyHTML = minify.HTML
	MinifyXML  = minify.XML
	MinifyJSON = minify.JSON
)

minifiers

var DefaultCompilePageData = func(out io.Writer, x map[string]any) error {
	t, err := template.New("").
		Funcs(Funcmap).
		Option("missingkey=zero").
		ParseFS(FS, "default.template.html")
	if err != nil {
		return err
	}
	return t.ExecuteTemplate(out, "default.template.html", x)
}

var Errorf = stackerr.Errorf

var FS fs.FS = embedded

FS that contains "./default.template.html"

var Funcmap = template.FuncMap{
	"minifyCSS":   MinifyCSS,
	"minifyJS":    MinifyJS,
	"minifySVG":   MinifySVG,
	"minifyHTML":  MinifyHTML,
	"minifyXML":   MinifyXML,
	"minifyJSON":  MinifyJSON,
	"minifyHTML2": MinifyHTML2,
}

var HTMLMinifier = mhtml.Minifier{
	KeepDefaultAttrVals: true,
	KeepDocumentTags:    true,
	KeepQuotes:          true,
	KeepWhitespace:      true,
	KeepEndTags:         true,
}

var Minify = minify.Default

Functions

func CompilePage

func CompilePage(out io.Writer, title, css, content string, headtags []string) error

CompilePage for AFTER rendering. Uses internal embedded template.

Puts the title, css, (and markdown2html pre-rendered body), into a basic html page

func Easy

func Easy(title, content string) string

func Markdown2HTMLPage

func Markdown2HTMLPage(out io.Writer, in []byte, title string) error

func Minifier

func Minifier(ct string, in string) string

func MinifierStream

func MinifierStream(mediatype string, out io.Writer, in io.Reader) (n int64, err error)

func MinifyHTML2

func MinifyHTML2(s string) (string, error)

Types

type Options

type Options struct {
	CompletePage    bool
	WithCSS         bool
	WithClassPrefix string
	Theme           string
	NoLineNumbers   bool
	WithClasses     bool
	DoWrap          bool // messes with line numbers
	NoMinify        bool

	html.Renderer
	parser.Parser
	Context renderer.Context
	Page
}

Options has Options.Init method which must be called befure Options.Markdown2HTMLString or Options.Markdown2HTMLString

see [defaultoption]

func Cfg

func Cfg() *Options

Cfg to modify the default before Init

func New

func New(title string) Options

func (*Options) Init

func (o *Options) Init()

func (Options) Markdown2HTML

func (o Options) Markdown2HTML(out io.Writer, in []byte) error

func (Options) Markdown2HTMLString

func (o Options) Markdown2HTMLString(in []byte) (string, error)

type Page

type Page struct {
	Title    string
	HeadTags []string
}