From 1d3b17501e907b58f7f18de3fbb03b92ffe9459e Mon Sep 17 00:00:00 2001
From: k4lizen <124312252+k4lizen@users.noreply.github.com>
Date: Sat, 12 Apr 2025 21:21:10 +0200
Subject: [PATCH] fix md frontmatter shown in readme (#2863)

---
 .github/workflows/docs-dev.yml     | 10 ++++++----
 .github/workflows/docs-release.yml |  4 ++--
 README.md                          |  5 -----
 scripts/generate_readme.sh         | 10 ++++++++++
 4 files changed, 18 insertions(+), 11 deletions(-)
 create mode 100755 scripts/generate_readme.sh

diff --git a/.github/workflows/docs-dev.yml b/.github/workflows/docs-dev.yml
index 17750159b..03cba77a6 100644
--- a/.github/workflows/docs-dev.yml
+++ b/.github/workflows/docs-dev.yml
@@ -25,8 +25,10 @@ jobs:
         run: |
           ./scripts/verify_docs.sh
 
-      - name: Copy README.md to docs/index.md
-        run: cp README.md docs/index.md
+      - name: Update docs/index.md with README.md
+        # This can be a simple copy if https://github.com/github/markup/issues/994
+        # is solved.
+        run: ./scripts/generate_readme.sh
 
       - name: Build site
         run: |
@@ -45,8 +47,8 @@ jobs:
       - name: Install uv
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
 
-      - name: Copy README.md to docs/index.md
-        run: cp README.md docs/index.md
+      - name: Update docs/index.md with README.md
+        run: ./scripts/generate_readme.sh
 
       - name: Deploy site
         run: |
diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml
index bd6d193d2..4fff8abc3 100644
--- a/.github/workflows/docs-release.yml
+++ b/.github/workflows/docs-release.yml
@@ -22,8 +22,8 @@ jobs:
       - name: Install uv
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
 
-      - name: Copy README.md to docs/index.md
-        run: cp README.md docs/index.md
+      - name: Update docs/index.md with README.md
+        run: ./scripts/generate_readme.sh
 
       - name: Deploy site
         run: |
diff --git a/README.md b/README.md
index f9f5e4950..a1822e20e 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,3 @@
----
-hide:
-  - navigation
----
-
 ![repository-open-graph](https://github.com/pwndbg/pwndbg/assets/150354584/77b2e438-898f-416f-a989-4bef30759627)
 # pwndbg
 
diff --git a/scripts/generate_readme.sh b/scripts/generate_readme.sh
new file mode 100755
index 000000000..48228ac90
--- /dev/null
+++ b/scripts/generate_readme.sh
@@ -0,0 +1,10 @@
+#!/bin/sh
+
+rm ./docs/index.md
+echo "---
+hide:
+  - navigation
+---
+" > ./docs/index.md
+
+cat ./README.md >> ./docs/index.md