Turn a public GitHub repository into a clickable tour.
A step-by-step guide to importing a public GitHub repository, generating source-inspired screens, editing hotspots, and backing up your DemoSynth tour.
Read the guide README WORKFLOWGive your README a demo people can click.
Create a DemoSynth cover image, copy linked Markdown, and add a clickable product demo card to your GitHub README with a working public tour URL.
Read the guideChoose your starting point
Use the GitHub guide when you have a public web application repository and want a source-inspired first draft. Use captured screenshots when you need to show the exact appearance of a running product.
Both paths arrive in the same studio. Review the screenshots, correct the labels, and decide what one useful outcome the tour should explain before adding more steps.
Keep the editable version
A README cover is an invitation to a tour, not an editable backup. Save the demo’s JSON as well as any image or written guide you export. A local JSON export contains the captured screenshots; cloud exports can refer to hosted image URLs.
Local previews work in the browser that saved the draft. A reader on another device needs a published tour with publicly reachable screenshots.