Skip to content

Commit 3621443

Browse files
authored
Include link-to-source info when generating docs (#642)
1 parent adc86ec commit 3621443

File tree

433 files changed

+3109
-458
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

433 files changed

+3109
-458
lines changed

.changeset/curvy-fans-sing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@livekit/components-js-docs": patch
3+
---
4+
5+
Include link-to-source info when generating docs. Add frontmatter section for generated markdown files.

docs/docs/generated-docs/core/activespeakerobserver.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
{
3+
"title": "activeSpeakerObserver",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

310
# activeSpeakerObserver

docs/docs/generated-docs/core/allparticipantevents.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "allParticipantEvents variable",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## allParticipantEvents variable
10+
# allParticipantEvents variable
411

512
**Signature:**
613

docs/docs/generated-docs/core/allparticipantroomevents.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "allParticipantRoomEvents variable",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## allParticipantRoomEvents variable
10+
# allParticipantRoomEvents variable
411

512
**Signature:**
613

docs/docs/generated-docs/core/allremoteparticipantevents.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "allRemoteParticipantEvents variable",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## allRemoteParticipantEvents variable
10+
# allRemoteParticipantEvents variable
411

512
**Signature:**
613

docs/docs/generated-docs/core/allremoteparticipantroomevents.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "allRemoteParticipantRoomEvents variable",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## allRemoteParticipantRoomEvents variable
10+
# allRemoteParticipantRoomEvents variable
411

512
**Signature:**
613

docs/docs/generated-docs/core/attachifsubscribed.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "attachIfSubscribed variable",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/utils.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## attachIfSubscribed variable
10+
# attachIfSubscribed variable
411

512
**Signature:**
613

docs/docs/generated-docs/core/audiosource.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "AudioSource type",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## AudioSource type
10+
# AudioSource type
411

512
**Signature:**
613

docs/docs/generated-docs/core/basedatamessage.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
---
2+
{
3+
"title": "BaseDataMessage interface",
4+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
5+
}
6+
---
7+
18
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
29

3-
## BaseDataMessage interface
10+
# BaseDataMessage interface
411

512
**Signature:**
613

docs/docs/generated-docs/core/basedatamessage.payload.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
---
2+
{ "title": "BaseDataMessage.payload property" }
3+
---
4+
15
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
26

3-
## BaseDataMessage.payload property
7+
# BaseDataMessage.payload property
48

59
**Signature:**
610

0 commit comments

Comments
 (0)