Embeds

You can show youtube videos, link cards, excalidraw diagrams and github repos in your documentation.

Youtube

Simply write a youtube url in your markdown like this (with nothing else on the same line):

https://www.youtube.com/watch?v=dQw4w9WgXcQ

Result:

Add any other url for a link card like this (again with nothing else on the same line):

https://flo-bit.dev

Result:

Excalidraw

You can also show excalidraw diagrams, that will be rendered in the correct dark/light mode like this (they must be in the src/assets folder):

:excalidraw[$assets/excalidraw-demo.svg]

Result:

You need adocumentationwebsite forproject AYou choose one of the existingtemplates(like this one!)You have a greatdocumentationwebsite quicklyYou don't like any of the existing templates and build one yourselfAfter weeks of workyou have built a nicedocumentation websiteYou forget about project AProject A isgoing strong

Github

You can show a github repo card by just writing the url like this (again with nothing else on the same line):

https://github.com/flo-bit/svelte-openai-realtime-api

Result:

🐶
Dogumentation