Files
gradio-webrtc/mkdocs.yml
Freddy Boulton 3147b5979c Add API Reference and llms.txt (#256)
* stream api reference

* docs

* Add code

* Add code

* code
2025-04-04 15:32:06 -04:00

73 lines
2.1 KiB
YAML

site_name: FastRTC
site_url: https://fastrtc.org
repo_name: fastrtc
repo_url: https://github.com/freddyaboulton/fastrtc
theme:
name: material
custom_dir: overrides
palette:
scheme: fastrtc-dark
features:
- content.code.copy
- content.code.annotate
- navigation.indexes
logo: fastrtc_logo.png
favicon: fastrtc_logo.png
extra_css:
- stylesheets/extra.css
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css
nav:
- Home: index.md
- User Guide:
- Core Concepts: userguide/streams.md
- Audio Streaming: userguide/audio.md
- Video Streaming: userguide/video.md
- Audio-Video Streaming: userguide/audio-video.md
- Gradio: userguide/gradio.md
- API: userguide/api.md
- Cookbook: cookbook.md
- Deployment: deployment.md
- Advanced Configuration: advanced-configuration.md
- Plugin Ecosystem:
- Text-to-Speech Gallery: text_to_speech_gallery.md
- Speech-to-Text Gallery: speech_to_text_gallery.md
- Turn-taking Gallery: turn_taking_gallery.md
- Utils: utils.md
- Frequently Asked Questions: faq.md
- API Reference:
- Stream: reference/stream.md
- Pause Detection Handlers: reference/reply_on_pause.md
- Stream Handlers: reference/stream_handlers.md
- Utils: reference/utils.md
extra_javascript:
- https://cdn.jsdelivr.net/npm/marked/marked.min.js
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- admonition
- pymdownx.details
plugins:
- llmstxt:
files:
- output: llms.txt
inputs:
- index.md
- userguide/*.md
- deployment.md
- advanced-configuration.md
- faq.md
- reference/*.md