summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAetias <aetias@outlook.com>2025-01-06 17:25:50 +0100
committerAetias <aetias@outlook.com>2025-01-06 17:25:50 +0100
commit53bd73e89c73f18ec8788baf45f43c0fdb02e145 (patch)
tree4940734e5a6aada1fdd677a26574e3d988ff5f94
parent2d8b257711ec638ec77bde1674df089d9d75dadf (diff)
pre-commit: Allow hard linebreaks in Markdown
-rw-r--r--.pre-commit-config.yaml2
-rw-r--r--docs/build_system.md2
-rw-r--r--docs/decompiling.md4
3 files changed, 5 insertions, 3 deletions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 705d42f3..8b2ebb4c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -15,6 +15,8 @@ repos:
- id: mixed-line-ending
- id: requirements-txt-fixer
- id: trailing-whitespace
+ args:
+ - --markdown-linebreak-ext=md
- repo: https://github.com/pre-commit/mirrors-clang-format
rev: v19.1.5
diff --git a/docs/build_system.md b/docs/build_system.md
index 82d32c6b..8b40d3ab 100644
--- a/docs/build_system.md
+++ b/docs/build_system.md
@@ -32,7 +32,7 @@ files to the project.
Each `delinks.txt` file belongs to one module, such as the ARM9 program, the ITCM, the DTCM or an overlay.
> [!NOTE]
-> For interested readers:
+> For interested readers:
> All modules are loaded into RAM. This is different from the DS predecessor, the Game Boy Advance (GBA), in which all code was
> simply on the ROM at all times. As a result, the GBA's RAM only consisted of variable data.
>
diff --git a/docs/decompiling.md b/docs/decompiling.md
index 6eb32c39..c572e6f2 100644
--- a/docs/decompiling.md
+++ b/docs/decompiling.md
@@ -24,9 +24,9 @@ We use the object diffing tool [`objdiff`](https://github.com/encounter/objdiff)
1. [Download the latest release.](https://github.com/encounter/objdiff/releases/latest)
1. Run `configure.py <eur|usa>` and `ninja` to generate `objdiff.json` in the repository root.
1. In `objdiff`, set the project directory to the repository root.
-1. Select your source file in the left sidebar:
+1. Select your source file in the left sidebar:
![List of objects in objdiff](images/objdiff_objects.png)
-5. See the list of functions and data to decompile:
+5. See the list of functions and data to decompile:
![List of symbols in objdiff](images/objdiff_symbols.png)
> [!NOTE]