docs: add animated hero image to README#1815
Open
livlign wants to merge 1 commit intomicrosoft:mainfrom
Open
Conversation
Author
|
Just flagging for transparency: this is a personal contribution — not submitted on behalf of a company or affiliated team. Happy to iterate on feedback or close it out if the direction doesn't fit. |
Author
|
@microsoft-github-policy-service agree |
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.
Summary
Proposes an animated hero at the top of
README.mdthat shows MarkItDown converting representative file types (PDF, PowerPoint, Word, Excel, HTML, images, audio) into LLM-ready Markdown in a single loop.docs/images/hero.gif(1200×675, ~2.3 MB, 20s loop)docs/images/hero.html— the editable source (single self-contained HTML file). Future maintainers can open it in any browser, tweak, and re-render.docs/images/README.md— documents the Puppeteer + ffmpeg pipeline so the GIF can be regenerated without archaeology.![…]line inREADME.mdbetween the badges row and the> [!IMPORTANT]security callout — placement keeps the security notice above the fold on mobile.Test plan
README.mdon GitHub and confirm the hero renders between the badges row and the IMPORTANT callout, and that the callout remains prominent.git revertthe single commit.Feel free to close if it isn't aligned with Microsoft's brand direction for the repo — happy to iterate or drop it.