Add language tags to fenced code blocks#74
Open
MustCodeAl wants to merge 1 commit intoguyinatuxedo:masterfrom
Open
Add language tags to fenced code blocks#74MustCodeAl wants to merge 1 commit intoguyinatuxedo:masterfrom
MustCodeAl wants to merge 1 commit intoguyinatuxedo:masterfrom
Conversation
Annotate triple-backtick code fences across many module README files with language identifiers (e.g., text, c, objdump, gdb, nasm, python, console, pycon) to enable proper syntax highlighting and improve readability of examples in assembly, tooling, and reversing guides. This is a non-behavioral doc change across numerous module readmes and does not alter example contents.
There was a problem hiding this comment.
Pull request overview
Annotates fenced code blocks across the training module READMEs with language identifiers to improve syntax highlighting for command output, disassembly, debugging sessions, and source snippets.
Changes:
- Added language tags (e.g.,
console,gdb,c,nasm,python,text,pycon,objdump) to many triple-backtick fences. - Standardized highlighting for common transcript types (shell sessions, GEF/GDB output, and disassembly listings).
Reviewed changes
Copilot reviewed 133 out of 133 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/next/readme.md | Adds text tags to URL/list code fences. |
| modules/7.2-mitigation_relro/readme.md | Tags GEF output blocks (e.g., gdb). |
| modules/7.1-mitigation_canary/readme.md | Tags disassembly/debug sections (gdb, nasm). |
| modules/6.1-mitigation_nx/readme.md | Tags GEF output blocks (gdb). |
| modules/5.1-mitigation_aslr_pie/readme.md | Tags gdb transcripts and mapping snippets (gdb, text). |
| modules/45-automatic_exploit_generation/readme.md | Tags workflow and transcript blocks (mixed content needs adjustment). |
| modules/44-more_tcache/csaw19_popping_caps1/readme.md | Tags C, GDB, Python, and console sections. |
| modules/43-house_of_orange/house_orange_exp/Readme.md | Tags C source and run output (run output tag needs adjustment). |
| modules/42-house_of_einherjar/house_einherjar_exp/readme.md | Tags C source and console run output. |
| modules/41-house_of_force/house_force_exp/readme.md | Tags C source and console run output. |
| modules/40-house_of_lore/house_lore_exp/readme.md | Tags C source and console run output. |
| modules/39-house_of_spirit/house_spirit_exp/readme.md | Tags C source and console run output. |
| modules/39-house_of_spirit/hacklu14_oreo/readme.md | Tags console, C, GDB, Python blocks. |
| modules/38-grab_bad/uninit_vars/readme.md | Tags C source and console run output. |
| modules/38-grab_bad/hackim19_shop/readme.md | Tags console, C, GDB, Python blocks. |
| modules/38-grab_bad/csaw19_gibberishCheck/readme.md | Tags console/C/GDB sections. |
| modules/36-obfuscated_reversing/csaw17_prophecy/Readme.md | Tags console/C/GDB/text/python sections. |
| modules/36-obfuscated_reversing/bkp16_unholy/Readme.md | Tags console/C/text/nasm/python sections (one Python block is mis-tagged). |
| modules/35-integer_exploitation/signed_unsigned/readme.md | Tags C source and console run output. |
| modules/35-integer_exploitation/puzzle/readme.md | Tags console/C/nasm/text/python blocks. |
| modules/35-integer_exploitation/int_overflow_post/readme.md | Tags console/C/python blocks. |
| modules/34-emulated_targets/csaw18_x86_pt2/readme.md | Tags console and nasm disassembly blocks. |
| modules/32-largebin_attack/largebin_explanation1/readme.md | Tags C source and console run output. |
| modules/32-largebin_attack/largebin_explanation0/README.md | Tags C source and console run output. |
| modules/31-unsortedbin_attack/unsorted_explanation/readme.md | Tags C source and console run output. |
| modules/31-unsortedbin_attack/hitcon_magicheap/readme.md | Tags console/C/GDB/text/python blocks. |
| modules/30-unlink/unlink_explanation/readme.md | Tags C source and console run output. |
| modules/29-tcache/tcache_explanation/readme.md | Tags C source and console run output. |
| modules/28-fastbin_attack/explanation_fastbinAttack/readme.md | Tags C source and console run output. |
| modules/27-edit_free_chunk/uaf_explanation/readme.md | Tags C source and console run output. |
| modules/27-edit_free_chunk/heap_consolidation_explanation/readme.md | Tags C source and console run output. |
| modules/27-edit_free_chunk/double_free_explanation/readme.md | Tags C source and console run output. |
| modules/26-heap_grooming/swamp19_heapgolf/readme.md | Tags console/nasm/gdb blocks. |
| modules/26-heap_grooming/pico_areyouroot/readme.md | Tags console/C/GDB/text blocks. |
| modules/26-heap_grooming/explanation_heap_grooming/readme.md | Tags C source and console run output. |
| modules/24-heap_overflow/protostar_heap2/reamdme.md | Tags console/C/GDB sections. |
| modules/24-heap_overflow/protostar_heap1/readme.md | Tags console/C/text/gdb sections. |
| modules/24-heap_overflow/protostar_heap0/readme.md | Tags console/C sections. |
| modules/23-custom_architecture/h3_h3machine3/readme.md | Tags console/text/pycon blocks. |
| modules/23-custom_architecture/h3_h3machine2/readme.md | Tags console/text blocks. |
| modules/23-custom_architecture/h3_h3machine1/readme.md | Tags console/nasm blocks. |
| modules/23-custom_architecture/h3_h3machine0/readme.md | Tags console/nasm blocks. |
| modules/22-movfuscation/swamp19_future/readme.md | Tags console/nasm/gdb/text blocks. |
| modules/22-movfuscation/recon_movfuscated/readme.md | Tags console blocks (one Python snippet is mis-tagged as nasm). |
| modules/22-movfuscation/asis18_babyc/readme.md | Tags console/nasm/objdump/gdb/text blocks. |
| modules/21-dot_net/whitehat18_re06/readme.md | Tags console/C/pycon/text blocks. |
| modules/21-dot_net/dot_net/readme.md | Tags console/text/c/pycon blocks. |
| modules/21-dot_net/bikinibonanza/readme.md | Tags console/C/text/nasm blocks. |
| modules/20-patching_and_jumping/plaid19_ppp/readme.md | Tags console/C/GDB/text blocks. |
| modules/20-patching_and_jumping/dcquals18_elfcrumble/readme.md | Tags console/GDB/text blocks. |
| modules/20-patching_and_jumping/csawquals16_gametime/readme.md | Tags console/nasm/c/text blocks. |
| modules/19-shellcoding_pt1/defconquals19_s6/readme.md | Tags console/C/GDB/python blocks. |
| modules/19-shellcoding_pt1/defconquals19_s3/readme.md | Tags console/C/pycon/python blocks. |
| modules/19-shellcoding_pt1/csaw18_shellpointcode/readme.md | Tags console/GDB/C/objdump/python blocks. |
| modules/17-stack_pivot/xctf16_b0verflow/readme.md | Tags console/C/GDB/python blocks. |
| modules/16-srop/swamp19_syscaller/readme.md | Tags console/nasm/gdb/text/python blocks. |
| modules/16-srop/inctf17_stupidrop/readme.md | Tags console/C/nasm/python blocks. |
| modules/16-srop/csaw19_smallboi/readme.md | Tags console/nasm/gdb/python blocks. |
| modules/16-srop/backdoor_funsignals/readme.md | Tags console/nasm/text/python blocks. |
| modules/15-partial_overwrite/tuctf17_vulnchat2/readme.md | Tags console/C/nasm/gdb/python blocks. |
| modules/15-partial_overwrite/tamu19_pwn2/readme.md | Tags console/C/nasm/gdb/python blocks. |
| modules/15-partial_overwrite/hacklu15_stackstuff/readme.md | Tags console/C/gdb/python blocks. |
| modules/14-ret_2_system/tu_guestbook/readme.md | Tags console/C/nasm/gdb/text/pycon/python blocks. |
| modules/14-ret_2_system/hxp18_poorCanary/readme.md | Tags console/C/nasm/text/python blocks. |
| modules/13-angr/securityfest_fairlight/readme.md | Tags console/C/nasm/text blocks. |
| modules/13-angr/plaid19_icancount/readme.md | Tags console/C/gdb/text/nasm blocks. |
| modules/13-angr/defcamp_r100/readme.md | Tags console/C/nasm/text blocks. |
| modules/12-z3/tuctf_future/readme.md | Tags console/C/pycon/text/python blocks. |
| modules/12-z3/hs19_abyte/readme.md | Tags console/C/nasm/python blocks. |
| modules/11-index/swampctf19_dreamheaps/readme.md | Tags console/C/gdb/python blocks. |
| modules/11-index/sunshinectf2017_alternatesolution/readme.md | Tags console/C blocks. |
| modules/11-index/dcq16_xkcd/readme.md | Tags console/C/text/python blocks. |
| modules/10-fmt_strings/pico18_echo/readme.md | Tags console/C (some console/GDB fences mis-tagged as c). |
| modules/09-bad_seed/sunshinectf17_prepared/readme.md | Tags console/C blocks. |
| modules/09-bad_seed/hsctf19_tuxtalkshow/readme.md | Tags console/C/nasm blocks. |
| modules/09-bad_seed/h3_time/readme.md | Tags console/C/text blocks. |
| modules/08-bof_dynamic/utc19_shellme/readme.md | Tags console/C/python/text blocks. |
| modules/08-bof_dynamic/hs19_storytime/readme.md | Tags console/C/gdb blocks. |
| modules/08-bof_dynamic/fb19_overfloat/readme.md | Tags console/C blocks. |
| modules/08-bof_dynamic/csaw19_babyboi/readme.md | Tags console/python blocks (initial console transcript mis-tagged as c). |
| modules/06-bof_shellcode/tu18_shellaeasy/readme.md | Tags console/C/gdb/python blocks. |
| modules/06-bof_shellcode/tamu19_pwn3/readme.md | Tags console/C/gdb/pycon/python blocks. |
| modules/06-bof_shellcode/csaw17_pilot/readme.md | Tags console/C/nasm/gdb/python blocks. |
| modules/05-bof_callfunction/tu17_vulnchat/readme.md | Tags console/C/nasm/gdb/python blocks. |
| modules/05-bof_callfunction/csaw18_getit/readme.md | Tags console/C/gdb/python blocks. |
| modules/05-bof_callfunction/csaw16_warmup/readme.md | Tags console/C/gdb/pycon/python blocks. |
| modules/04-bof_variable/tamu19_pwn1/Readme.md | Tags console/C/python blocks. |
| modules/04-bof_variable/csaw18_boi/Readme.md | Tags console/C/nasm/gdb/python blocks. |
| modules/03-beginner_re/pico18_strings/readme.md | Tags console blocks. |
| modules/03-beginner_re/helithumper_re/readme.md | Tags console/C/nasm/text/pycon blocks. |
| modules/03-beginner_re/csaw19_beleaf/readme.md | Tags console/C/nasm blocks. |
| modules/03-beginner_re/csaw18_x86tour_pt1/readme.md | Tags nasm code blocks. |
| modules/02-intro_tooling/pwntools/readme.md | Tags console/python blocks. |
| modules/02-intro_tooling/ghidra/readme.md | Tags link list as text. |
| modules/02-intro_tooling/gdb-gef/symbols.md | Tags C/console/gdb blocks. |
| modules/01-intro_assembly/reversing_assembly/readme.md | Tags console/objdump/text/nasm blocks. |
Comments suppressed due to low confidence (4)
modules/08-bof_dynamic/csaw19_babyboi/readme.md:9
- This fenced block is tagged as
c, but it’s a terminal transcript (file,checksec, running binaries,cat baby_boi.c). Useconsole(and keep the actual C source in a separatecfence if desired).
```c
$ file baby_boi
baby_boi: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 3.2.0, BuildID[sha1]=e1ff55dce2efc89340b86a666bba5e7ff2b37f62, not stripped
$ pwn checksec baby_boi
[*] '/Hackery/pod/modules/8-bof_dynamic/csaw19_babyboi/baby_boi'
modules/45-automatic_exploit_generation/readme.md:40
- This fence is tagged as
python, but the block mixes console output, shell commands, and a Python file listing. Either retag astext/consoleor split it into separate fenced blocks so highlighting matches each section.
modules/10-fmt_strings/pico18_echo/readme.md:9 - This block shows shell commands and program output (e.g.,
file,pwn checksec, running./echo), but it’s tagged asc. Tag it asconsoleinstead to avoid misleading highlighting.
modules/10-fmt_strings/pico18_echo/readme.md:68 - The section starting this fence is a GDB session (
gdb ./echo,gef➤ r, register dump, etc.) but the fence is tagged asc. Considergdborconsolefor accurate syntax highlighting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Annotate triple-backtick code fences across many module README files with language identifiers (e.g., text, c, objdump, gdb, nasm, python, console, pycon) to enable proper syntax highlighting and improve readability of examples in assembly, tooling, and reversing guides. This is a non-behavioral doc change across numerous module readmes and does not alter example contents.