flo-bit.dev
[READ-ONLY] Mirror of https://github.com/flo-bit/dogumentation. Simple, minimalistic documentation template using astro
flo-bit.dev/dogumentation/
1.1 kB
50 lines
1---
2title: "Embeds"
3description: "Show embeds in your documentation"
4category: "Components"
5---
6
7# Embeds
8
9You can show youtube videos, link cards, excalidraw diagrams and github repos in your documentation.
10
11## Youtube
12
13Simply write a youtube url in your markdown like this (with nothing else on the same line):
14
15```mdx
16https://www.youtube.com/watch?v=dQw4w9WgXcQ
17```
18
19https://www.youtube.com/watch?v=dQw4w9WgXcQ
20
21## Link Card
22
23Add any other url for a link card like this (again with nothing else on the same line):
24
25```mdx
26https://flo-bit.dev
27```
28
29https://flo-bit.dev
30
31## Excalidraw
32
33You can also show excalidraw diagrams, that will be rendered in the correct dark/light mode like this
34(they **must** be in the `src/assets` folder):
35
36```mdx
37:excalidraw[$assets/excalidraw-demo.svg]
38```
39
40:excalidraw[$assets/excalidraw-demo.svg]
41
42## Github
43
44You can show a github repo card by just writing the url like this (again with nothing else on the same line):
45
46```mdx
47https://github.com/flo-bit/svelte-openai-realtime-api
48```
49
50https://github.com/flo-bit/svelte-openai-realtime-api