Show demo gif on docs front page (#3055)

* show gif on docs frontpage

* use uv for running the script

* gif but invoked as `pwndbg /bin/sh`

* add cheatsheet to repository

.github/workflows/docs-dev.yml

@@ -34,9 +34,7 @@ jobs:
           ./scripts/verify-docs.sh
 
       - 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
+        run: uv run ./scripts/generate-readme.py
 
       - name: Build site
         run: |
@@ -61,7 +59,7 @@ jobs:
         run: uv sync --group docs
 
       - name: Update docs/index.md with README.md
-        run: ./scripts/generate-readme.sh
+        run: uv run ./scripts/generate-readme.py
 
       - name: Deploy site
         run: |

.github/workflows/docs-release.yml

@@ -28,7 +28,7 @@ jobs:
         run: uv sync --group docs
 
       - name: Update docs/index.md with README.md
-        run: ./scripts/generate-readme.sh
+        run: uv run ./scripts/generate-readme.py
 
       - name: Deploy site
         run: |

README.md

@@ -14,7 +14,7 @@ It has a boatload of features, see our [Features page](https://pwndbg.re/pwndbg/
 and [CHEATSHEET][CHEATSHEET] (feel free to print it!). If you have any questions you may read the
 [documentation](https://pwndbg.re/pwndbg/latest/) or asks us in our [Discord server](https://discord.gg/x47DssnGwm).
 
-[CHEATSHEET]: https://drive.google.com/file/d/16t9MV8KTFXK7oX_CzXhmDdaVnjT8IYM4/view?usp=drive_link
+[CHEATSHEET]: https://pwndbg.re/pwndbg/latest/CHEATSHEET.pdf
 
 ## Why?
 

docs/assets/videos/demo.tape

@@ -0,0 +1,67 @@
+# https://github.com/charmbracelet/vhs
+
+Output demo.mp4
+Output demo.webm
+
+Set FontSize 20
+Set Width 1920
+Set Height 1080
+Set TypingSpeed 100ms
+
+Sleep 1s
+Type "pwndbg /bin/sh"
+Enter
+Sleep 2s
+Type "start"
+Enter
+Sleep 3s
+Type "ni"
+Sleep 2s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Type "nextcall"
+Sleep 3s
+Enter 1
+Sleep 10s
+Type "b *$rdi"
+Sleep 1s
+Enter 1
+Sleep 2s
+Type "continue"
+Sleep 1s
+Enter 1
+Sleep 4s
+Type "nextcall"
+Sleep 1s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Enter 1
+Sleep 1s
+Type "stepsyscall"
+Sleep 1s
+Enter 1
+Sleep 10s
+Type "checksec"
+Sleep 1s
+Enter 1
+Sleep 5s
+Type "vmmap"
+Sleep 1s
+Enter 1
+Sleep 5s
+Type "exit"
+Sleep 1s
+Enter
+Sleep 2s

mkdocs.yml

@@ -56,7 +56,7 @@ theme:
     - search.share
 # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
     # Adds an edit button to every page that links to the repository.
-    - content.action.edit
+    # - content.action.edit
 # Extra
     # Sync the content tab selection across the whole site (based on label).
     - content.tabs.link

scripts/generate-readme.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python
+"""
+Transform the README.md to look good on the
+documentation page.
+"""
+
+from __future__ import annotations
+
+hide_nav = """---
+hide:
+  - navigation
+---
+"""
+
+gif = """
+<video autoplay loop muted playsinline alt='pwndbg gif'>
+  <source src='assets/videos/demo.webm' type='video/webm'>
+  <source src='assets/videos/demo.mp4' type='video/mp4'>
+</video>
+"""
+
+
+def main():
+    README_PATH = "README.md"
+    TARGET_PATH = "./docs/index.md"
+
+    with open(README_PATH, "r") as readmefile:
+        readme = readmefile.read()
+
+        assert (
+            readme.splitlines()[0].startswith("![repository-open-graph](")
+            and "The first line of the README.md has changed. Is it still safe to replace it?"
+        )
+
+        # Delete the first line
+        readme = readme.split("\n", 1)[1]
+
+        # Hide navigation on the doc page
+        preamble = hide_nav
+        # Add logo
+        preamble += "\n![logo](assets/logo2.png){ style='width: 100%'}\n"
+
+        readme = preamble + readme
+
+        # Add gif after first paragraph
+        assert "## Why?" in readme
+        readme = readme.replace("## Why?\n", gif + "\n## Why?\n")
+
+        # Write to target file.
+        with open(TARGET_PATH, "w") as docsindex:
+            docsindex.write(readme)
+
+
+if __name__ == "__main__":
+    main()

scripts/generate-readme.sh

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-
-rm ./docs/index.md
-echo "---
-hide:
-  - navigation
----
-" > ./docs/index.md
-
-cat ./README.md >> ./docs/index.md