fix md frontmatter shown in readme (#2863)

.github/workflows/docs-dev.yml

@@ -25,8 +25,10 @@ jobs:
         run: |
           ./scripts/verify_docs.sh
 
-      - name: Copy README.md to docs/index.md
+      - name: Update docs/index.md with README.md
-        run: cp README.md docs/index.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
+      - name: Update docs/index.md with README.md
-        run: cp README.md docs/index.md
+        run: ./scripts/generate_readme.sh
 
       - name: Deploy site
         run: |

.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
+      - name: Update docs/index.md with README.md
-        run: cp README.md docs/index.md
+        run: ./scripts/generate_readme.sh
 
       - name: Deploy site
         run: |

README.md

@@ -1,8 +1,3 @@
----
-hide:
-  - navigation
----
-
 ![repository-open-graph](https://github.com/pwndbg/pwndbg/assets/150354584/77b2e438-898f-416f-a989-4bef30759627)
 # pwndbg
 

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