add alert blocks

README.md

@@ -20,6 +20,10 @@ To install go-grip, simply:
 go install github.com/chrishrb/go-grip@latest
 ```
 
+> [!TIP]
+> You can also use nix flakes to install this plugin.
+> More useful information [here](https://nixos.wiki/wiki/Flakes).
+
 ## 🔨 Usage
 
 To render the `README.md` file simply execute:
@@ -58,11 +62,6 @@ To terminate the current server simply press `CTRL-C`.
 
 ## 🐛 Known TODOs / Bugs
 
-* [ ] GitHub alert block
- ```md
- > [!NOTE]
- > Useful information that users should know, even when skimming content.
- ```
 * [ ] Checkboxes (like in this todo list)
 * [ ] Tests and refactoring
 

pkg/parser.go

@@ -1,8 +1,13 @@
 package pkg
 
 import (
+ "bytes"
+ "fmt"
+ "html/template"
  "io"
  "log"
+ "path/filepath"
+ "strings"
 
  "github.com/alecthomas/chroma/v2/quick"
  "github.com/gomarkdown/markdown"
@@ -11,26 +16,38 @@ import (
  "github.com/gomarkdown/markdown/parser"
 )
 
+var blockquotes = []string{"Note", "Tip", "Important", "Warning", "Caution"}
+
 func (client *Client) MdToHTML(bytes []byte) []byte {
  extensions := parser.CommonExtensions | parser.AutoHeadingIDs
  p := parser.NewWithExtensions(extensions)
  doc := p.Parse(bytes)
 
  htmlFlags := html.CommonFlags
- opts := html.RendererOptions{Flags: htmlFlags, RenderNodeHook: client.renderHookCodeBlock}
+ opts := html.RendererOptions{Flags: htmlFlags, RenderNodeHook: client.renderHook}
  renderer := html.NewRenderer(opts)
 
  return markdown.Render(doc, renderer)
 }
 
-func (client *Client) renderHookCodeBlock(w io.Writer, node ast.Node, entering bool) (ast.WalkStatus, bool) {
- block, ok := node.(*ast.CodeBlock)
- if !ok {
- return ast.GoToNext, false
+func (client *Client) renderHook(w io.Writer, node ast.Node, entering bool) (ast.WalkStatus, bool) {
+ switch node.(type) {
+ case *ast.BlockQuote:
+ return renderHookBlockquote(w, node, entering)
+ case *ast.Text:
+ return renderHookText(w, node)
+ case *ast.CodeBlock:
+ return renderHookCodeBlock(w, node, client.Dark)
  }
 
+ return ast.GoToNext, false
+}
+
+func renderHookCodeBlock(w io.Writer, node ast.Node, dark bool) (ast.WalkStatus, bool) {
+ block := node.(*ast.CodeBlock)
+
  var style string
- switch client.Dark {
+ switch dark {
  case true:
  style = "github-dark"
  default:
@@ -41,6 +58,81 @@ func (client *Client) renderHookCodeBlock(w io.Writer, node ast.Node, entering b
  if err != nil {
  log.Println("Error:", err)
  }
+ return ast.GoToNext, true
+}
+
+func renderHookBlockquote(w io.Writer, node ast.Node, entering bool) (ast.WalkStatus, bool) {
+ block := node.(*ast.BlockQuote)
+
+ paragraph, ok := (block.GetChildren()[0]).(*ast.Paragraph)
+ if !ok {
+ return ast.GoToNext, false
+ }
+
+ t, ok := (paragraph.GetChildren()[0]).(*ast.Text)
+ if !ok {
+ return ast.GoToNext, false
+ }
+
+ // Get the text content of the blockquote
+ content := string(t.Literal)
+
+ var alert string
+ for _, b := range blockquotes {
+ if strings.HasPrefix(content, fmt.Sprintf("[!%s]", strings.ToUpper(b))) {
+ alert = strings.ToLower(b)
+ }
+ }
+
+ if alert == "" {
+ return ast.GoToNext, false
+ }
+
+ // Set the message type based on the content of the blockquote
+ if entering {
+ s, _ := createBlockquoteStart(alert)
+ io.WriteString(w, s)
+ } else {
+ io.WriteString(w, "</div>")
+ }
 
  return ast.GoToNext, true
 }
+
+func renderHookText(w io.Writer, node ast.Node) (ast.WalkStatus, bool) {
+ block := node.(*ast.Text)
+
+ paragraph, ok := block.GetParent().(*ast.Paragraph)
+ if !ok {
+ return ast.GoToNext, false
+ }
+
+ _, ok = paragraph.GetParent().(*ast.BlockQuote)
+ if !ok {
+ return ast.GoToNext, false
+ }
+
+ // Remove prefixes
+ for _, b := range blockquotes {
+ content, found := strings.CutPrefix(string(block.Literal), fmt.Sprintf("[!%s]", strings.ToUpper(b)))
+ if found {
+ io.WriteString(w, content)
+ return ast.GoToNext, true
+ }
+ }
+
+ return ast.GoToNext, false
+}
+
+func createBlockquoteStart(alert string) (string, error) {
+ lp := filepath.Join("templates/alert", fmt.Sprintf("%s.html", alert))
+ tmpl, err := template.ParseFiles(lp)
+ if err != nil {
+ return "", err
+ }
+ var tpl bytes.Buffer
+ if err := tmpl.Execute(&tpl, alert); err != nil {
+ return "", err
+ }
+ return tpl.String(), nil
+}

templates/alert/caution.html

@@ -0,0 +1,8 @@
+<div class="markdown-alert markdown-alert-caution" dir="auto">
+ <p class="markdown-alert-title" dir="auto">
+ <svg class="octicon octicon-stop mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">
+ <path
+ d="M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z">
+ </path>
+ </svg>Caution
+ </p>

templates/alert/important.html

@@ -0,0 +1,9 @@
+<div class="markdown-alert markdown-alert-important" dir="auto">
+ <p class="markdown-alert-title" dir="auto">
+ <svg class="octicon octicon-report mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16"
+ aria-hidden="true">
+ <path
+ d="M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z">
+ </path>
+ </svg>Important
+ </p>

templates/alert/note.html

@@ -0,0 +1,8 @@
+<div class="markdown-alert markdown-alert-note" dir="auto">
+ <p class="markdown-alert-title" dir="auto">
+ <svg class="octicon octicon-info mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">
+ <path
+ d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z">
+ </path>
+ </svg>Note
+ </p>

templates/alert/tip.html

@@ -0,0 +1,9 @@
+<div class="markdown-alert markdown-alert-tip" dir="auto">
+ <p class="markdown-alert-title" dir="auto">
+ <svg class="octicon octicon-light-bulb mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16"
+ aria-hidden="true">
+ <path
+ d="M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z">
+ </path>
+ </svg>Tip
+ </p>

templates/alert/warning.html

@@ -0,0 +1,8 @@
+<div class="markdown-alert markdown-alert-warning" dir="auto">
+ <p class="markdown-alert-title" dir="auto">
+ <svg class="octicon octicon-alert mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">
+ <path
+ d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z">
+ </path>
+ </svg>Warning
+ </p>