hugo-asm-shortcode

A Hugo shortcode for displaying assembly code blocks with syntax highlighting, hex bytes, and memory addresses.

Features

• Syntax highlighting for x86 (NASM) and ARM assembly
• Four display modes:
  • raw - Assembly with syntax highlighting only
  • hex - Hex bytes + assembly instruction
  • full - Address + hex bytes + assembly instruction
  • ida - IDA-style section:address + assembly instruction
• Capitalization option for hex bytes and addresses
• Dark/light mode compatible

Module Structure

This project is structured as a Hugo module with the following components:

• layouts/shortcodes/asm.html - The shortcode template
• assets/css/extended/asm.css - Styling for assembly code blocks
• hugo.toml - Module mount configuration
• go.mod - Go module definition

Installation

As a Hugo Module

Add to your hugo.toml:

[module]
  [[module.imports]]
    path = "github.com/NohamR/hugo-asm-shortcode"

Manual Installation

Copy the following files to your Hugo site:

• layouts/shortcodes/asm.html → your site's layouts/shortcodes/
• assets/css/extended/asm.css → your site's assets/css/extended/

Usage

Raw Mode (syntax highlighting only)

{{</* asm mode="raw" arch="x86" */>}}
mov rax, 1
xor rdi, rdi
syscall
{{</* /asm */>}}

Hex Mode (hex bytes + instruction)

{{</* asm mode="hex" arch="x86" */>}}
48 c7 c0 01 00 00 00 | mov rax, 1
48 31 ff             | xor rdi, rdi
0f 05                | syscall
{{</* /asm */>}}

Full Mode (address + hex + instruction)

{{</* asm mode="full" arch="x86" */>}}
00401000 | 48 c7 c0 01 00 00 00 | mov rax, 1
00401007 | 48 31 ff             | xor rdi, rdi
0040100a | 0f 05                | syscall
{{</* /asm */>}}

IDA Mode (IDA-style section:address + instruction)

{{</* asm mode="ida" arch="x86" */>}}
__text:000000010045C182 | mov     rdi, [rbp+var_88]
__text:000000010045C189 | call    _RuntimeUnlockString
__text:000000010045C18E | mov     [rbp+var_88], 0
{{</* /asm */>}}

Parameters

Parameter	Default	Description
mode	raw	Display mode: raw, hex, full, or ida
arch	x86	Architecture: x86 or arm
capitalize	false	Uppercase hex bytes and addresses when true

Demo

See a live demo at noh.am/en/posts/asm/

License

MIT License - see LICENSE for details.