%s
6 | {{.title}}
5 |{{.subtitle}}
6 |{{.byline}}
11 || Sun | 33 |Mon | 34 |Tue | 35 |Wed | 36 |Thu | 37 |Fri | 38 |Sat | 39 |
|---|---|---|---|---|---|---|
| 46 | {{if .}} 47 | 48 | {{ if .Pages }} 49 | 50 | {{.Date.Day}} 51 | 52 | {{else}} 53 | {{.Date.Day}} 54 | {{end}} 55 | 56 | {{ if .Pages }} 57 | 72 | {{end}} 73 | 74 | {{end}} 75 | | 76 | {{end}} 77 |
` + r.startDelim) 88 | l := n.Lines().Len() 89 | for i := 0; i < l; i++ { 90 | line := n.Lines().At(i) 91 | w.Write(line.Value(source)) 92 | } 93 | } else { 94 | _, _ = w.WriteString(r.endDelim + `
` + "\n" + script) 95 | } 96 | return ast.WalkContinue, nil 97 | } 98 | -------------------------------------------------------------------------------- /extensions/mermaid/main.go: -------------------------------------------------------------------------------- 1 | package mermaid 2 | 3 | import ( 4 | "fmt" 5 | "html/template" 6 | 7 | _ "embed" 8 | 9 | . "github.com/emad-elsaid/xlog" 10 | shortcode "github.com/emad-elsaid/xlog/extensions/shortcode" 11 | ) 12 | 13 | func init() { 14 | RegisterExtension(Mermaid{}) 15 | } 16 | 17 | type Mermaid struct{} 18 | 19 | func (Mermaid) Name() string { return "mermaid" } 20 | func (Mermaid) Init() { 21 | shortcode.RegisterShortCode("mermaid", shortcode.ShortCode{Render: renderer}) 22 | } 23 | 24 | //go:embed script.html 25 | var script string 26 | 27 | const pre = `%s` 28 | 29 | func renderer(md Markdown) template.HTML { 30 | html := fmt.Sprintf(pre, md) 31 | return template.HTML(html + script) 32 | 33 | } 34 | -------------------------------------------------------------------------------- /extensions/mermaid/script.html: -------------------------------------------------------------------------------- 1 | 9 | -------------------------------------------------------------------------------- /extensions/photos/templates/photo.html: -------------------------------------------------------------------------------- 1 |
11 | /alert this is important 12 |13 | 14 | /alert this is important 15 | 16 | # Long format 17 | 18 |
19 | ```alert 20 | this is important 21 | ``` 22 |23 | 24 | ```alert 25 | this is important 26 | ``` 27 | 28 | # Default blocks 29 | 30 | Shortcode extension includes couple default blocks: 31 | 32 | ## /alert 33 | 34 | ```alert 35 | Computer science is the study of computation, automation, and information. Computer science spans theoretical disciplines (such as algorithms, theory of computation, information theory, and automation) to practical disciplines (including the design and implementation of hardware and software). Computer science is generally considered an area of academic research and distinct from computer programming. 36 | ``` 37 | 38 | ## /info 39 | 40 | ```info 41 | Computer science is the study of computation, automation, and information. Computer science spans theoretical disciplines (such as algorithms, theory of computation, information theory, and automation) to practical disciplines (including the design and implementation of hardware and software). Computer science is generally considered an area of academic research and distinct from computer programming. 42 | ``` 43 | 44 | ## /success 45 | 46 | ```success 47 | Computer science is the study of computation, automation, and information. Computer science spans theoretical disciplines (such as algorithms, theory of computation, information theory, and automation) to practical disciplines (including the design and implementation of hardware and software). Computer science is generally considered an area of academic research and distinct from computer programming. 48 | ``` 49 | 50 | ## /warning 51 | 52 | ```warning 53 | Computer science is the study of computation, automation, and information. Computer science spans theoretical disciplines (such as algorithms, theory of computation, information theory, and automation) to practical disciplines (including the design and implementation of hardware and software). Computer science is generally considered an area of academic research and distinct from computer programming. 54 | ``` 55 | -------------------------------------------------------------------------------- /extensions/shortcode/extension.go: -------------------------------------------------------------------------------- 1 | package shortcode 2 | 3 | import ( 4 | . "github.com/emad-elsaid/xlog" 5 | "github.com/yuin/goldmark/parser" 6 | "github.com/yuin/goldmark/renderer" 7 | "github.com/yuin/goldmark/util" 8 | ) 9 | 10 | func init() { 11 | RegisterExtension(ShortCodeEx{}) 12 | } 13 | 14 | type ShortCodeEx struct{} 15 | 16 | func (ShortCodeEx) Name() string { return "shortcode" } 17 | func (ShortCodeEx) Init() { 18 | MarkdownConverter().Parser().AddOptions(parser.WithBlockParsers( 19 | util.Prioritized(&shortCodeParser{}, 0), 20 | )) 21 | MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers( 22 | util.Prioritized(&shortCodeRenderer{}, 0), 23 | )) 24 | MarkdownConverter().Parser().AddOptions( 25 | parser.WithASTTransformers( 26 | util.Prioritized(transformShortCodeBlocks{}, 0), 27 | ), 28 | ) 29 | } 30 | -------------------------------------------------------------------------------- /extensions/shortcode/node.go: -------------------------------------------------------------------------------- 1 | package shortcode 2 | 3 | import ( 4 | "fmt" 5 | 6 | "github.com/yuin/goldmark/ast" 7 | ) 8 | 9 | var KindShortCode = ast.NewNodeKind("ShortCode") 10 | 11 | type ShortCodeNode struct { 12 | ast.BaseBlock 13 | start int 14 | end int 15 | fun ShortCode 16 | } 17 | 18 | func (s *ShortCodeNode) Dump(source []byte, level int) { 19 | m := map[string]string{ 20 | "value": fmt.Sprintf("%#v", s), 21 | } 22 | ast.DumpHelper(s, source, level, m, nil) 23 | } 24 | 25 | func (h *ShortCodeNode) Kind() ast.NodeKind { 26 | return KindShortCode 27 | } 28 | 29 | var KindShortCodeBlock = ast.NewNodeKind("ShortCodeBlock") 30 | 31 | type ShortCodeBlock struct { 32 | ast.FencedCodeBlock 33 | fun ShortCode 34 | } 35 | 36 | func (s *ShortCodeBlock) Kind() ast.NodeKind { 37 | return KindShortCodeBlock 38 | } 39 | -------------------------------------------------------------------------------- /extensions/shortcode/parser.go: -------------------------------------------------------------------------------- 1 | package shortcode 2 | 3 | import ( 4 | "strings" 5 | 6 | "github.com/yuin/goldmark/ast" 7 | "github.com/yuin/goldmark/parser" 8 | "github.com/yuin/goldmark/text" 9 | ) 10 | 11 | const trigger = '/' 12 | 13 | type shortCodeParser struct{} 14 | 15 | func (s *shortCodeParser) Trigger() []byte { 16 | return []byte{trigger} 17 | } 18 | 19 | func (s *shortCodeParser) Open(parent ast.Node, reader text.Reader, pc parser.Context) (ast.Node, parser.State) { 20 | l, seg := reader.PeekLine() 21 | line := string(l) 22 | if len(line) == 0 || line[0] != trigger { 23 | return nil, parser.Close 24 | } 25 | 26 | endOfShortcode := strings.IndexAny(line, " \n") 27 | if endOfShortcode == -1 { 28 | endOfShortcode = len(line) 29 | } 30 | 31 | firstWord := line[1:endOfShortcode] 32 | var processor ShortCode 33 | var ok bool 34 | if processor, ok = shortcodes[firstWord]; !ok { 35 | return nil, parser.Close 36 | } 37 | 38 | reader.AdvanceLine() 39 | 40 | firstSpace := strings.IndexAny(line, " ") 41 | if firstSpace == -1 { 42 | return &ShortCodeNode{ 43 | start: seg.Stop, 44 | end: seg.Stop, 45 | fun: processor, 46 | }, parser.Close 47 | } 48 | 49 | return &ShortCodeNode{ 50 | start: seg.Start + endOfShortcode, 51 | end: seg.Stop, 52 | fun: processor, 53 | }, parser.Close 54 | } 55 | 56 | func (s *shortCodeParser) Continue(node ast.Node, reader text.Reader, pc parser.Context) parser.State { 57 | return parser.Close 58 | } 59 | 60 | func (s *shortCodeParser) Close(node ast.Node, reader text.Reader, pc parser.Context) {} 61 | func (s *shortCodeParser) CanInterruptParagraph() bool { return true } 62 | func (s *shortCodeParser) CanAcceptIndentedLine() bool { return false } 63 | -------------------------------------------------------------------------------- /extensions/shortcode/parser_test.go: -------------------------------------------------------------------------------- 1 | package shortcode_test 2 | 3 | import ( 4 | "bytes" 5 | "html/template" 6 | "testing" 7 | 8 | "github.com/emad-elsaid/xlog" 9 | "github.com/emad-elsaid/xlog/extensions/shortcode" 10 | ) 11 | 12 | func TestShortCode(t *testing.T) { 13 | tcs := []struct { 14 | name string 15 | input string 16 | handlerOutput string 17 | output string 18 | }{ 19 | { 20 | name: "page with one line", 21 | input: "/test", 22 | handlerOutput: "output", 23 | output: "output", 24 | }, 25 | { 26 | name: "short code with new line before it", 27 | input: "\n/test", 28 | handlerOutput: "output", 29 | output: "output", 30 | }, 31 | { 32 | name: "short code with new line after it", 33 | input: "/test\n", 34 | handlerOutput: "output", 35 | output: "output", 36 | }, 37 | { 38 | name: "short code with new line before and after it", 39 | input: "\n/test\n", 40 | handlerOutput: "output", 41 | output: "output", 42 | }, 43 | { 44 | name: "short code with space after", 45 | input: "/test ", 46 | handlerOutput: "output", 47 | output: "output", 48 | }, 49 | { 50 | name: "two short codes", 51 | input: "/test\n\n/test", 52 | handlerOutput: "output", 53 | output: "outputoutput", 54 | }, 55 | } 56 | 57 | for _, tc := range tcs { 58 | t.Run(tc.name, func(t *testing.T) { 59 | handler := func(xlog.Markdown) template.HTML { return template.HTML(tc.handlerOutput) } 60 | shortcode.RegisterShortCode("test", shortcode.ShortCode{Render: handler, Default: ""}) 61 | 62 | output := bytes.NewBufferString("") 63 | xlog.MarkdownConverter().Convert([]byte(tc.input), output) 64 | if output.String() != tc.output { 65 | t.Errorf("input: %s\nexpected: %s\noutput: %s", tc.input, tc.output, output.String()) 66 | } 67 | }) 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /extensions/shortcode/renderer.go: -------------------------------------------------------------------------------- 1 | package shortcode 2 | 3 | import ( 4 | . "github.com/emad-elsaid/xlog" 5 | "github.com/yuin/goldmark/ast" 6 | "github.com/yuin/goldmark/renderer" 7 | "github.com/yuin/goldmark/util" 8 | ) 9 | 10 | type shortCodeRenderer struct{} 11 | 12 | func (s *shortCodeRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) { 13 | reg.Register(KindShortCode, s.render) 14 | reg.Register(KindShortCodeBlock, s.renderBlock) 15 | } 16 | 17 | func (s *shortCodeRenderer) render(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) { 18 | if !entering { 19 | return ast.WalkContinue, nil 20 | } 21 | 22 | node, ok := n.(*ShortCodeNode) 23 | if !ok { 24 | return ast.WalkContinue, nil 25 | } 26 | 27 | content := source[node.start:node.end] 28 | output := node.fun.Render(Markdown(content)) 29 | w.Write([]byte(output)) 30 | 31 | return ast.WalkContinue, nil 32 | } 33 | 34 | func (s *shortCodeRenderer) renderBlock(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) { 35 | if !entering { 36 | return ast.WalkContinue, nil 37 | } 38 | 39 | node, ok := n.(*ShortCodeBlock) 40 | if !ok { 41 | return ast.WalkContinue, nil 42 | } 43 | 44 | lines := node.Lines() 45 | content := "" 46 | for i := 0; i < lines.Len(); i++ { 47 | line := lines.At(i) 48 | content += string(line.Value(source)) 49 | } 50 | 51 | output := node.fun.Render(Markdown(content)) 52 | w.Write([]byte(output)) 53 | 54 | return ast.WalkContinue, nil 55 | } 56 | -------------------------------------------------------------------------------- /extensions/shortcode/shortcode.go: -------------------------------------------------------------------------------- 1 | package shortcode 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "html/template" 7 | 8 | . "github.com/emad-elsaid/xlog" 9 | ) 10 | 11 | type ShortCode struct { 12 | Render func(Markdown) template.HTML 13 | Default string 14 | } 15 | 16 | func render(i Markdown) string { 17 | var b bytes.Buffer 18 | MarkdownConverter().Convert([]byte(i), &b) 19 | return b.String() 20 | } 21 | 22 | func container(cls string, content Markdown) template.HTML { 23 | tpl := `
Recording
6 |Recording
6 |{{.}}
{{ end }} 42 | {{- emoji . }} {{ base .Name }} 43 | {{ end }} 44 | {{- end -}} 45 || 20 | 21 | {{.Name}} 22 | | 23 |{{.Value}} | 24 |
|---|