Files
phaten-audio/zh/mkdocs.yml
PhatenIoT-yan e469ee0144 update
2026-03-09 16:50:37 +08:00

348 lines
14 KiB
YAML

# ref link: https://alinex.gitlab.io/env/mkdocs/
#===================================================================================#
# Site Information
#===================================================================================#
site_name: 飞腾云音频|XMOS AI专业音频方案商|XMOS官方授权增值分销商(VAR)
site_description: 深圳市飞腾云科技有限公司-XMOS官方授权增值分销商(VAR)
site_url: https://phaten-audio.com
site_author: Phaten
site_dir: '../../site/zh'
copyright: Copyright &copy; 2024 <a href="https://www.phaten-audio.com">深圳市飞腾云科技有限公司</a>
site_login: true
login_name: 登录/注册
login_url: /zh/login
#===================================================================================#
# Mkdocs Theme (Material Mkdocs) + Extras
#===================================================================================#
theme:
name: material
custom_dir: material/templates
language: en
#logo: assets/images/logos/binbash-icon.png
# icon: # https://www.materialpalette.com/icons
logo: assets/images/logos/phaten-logo-cn.png
favicon: assets/images/logos/phaten-logo-ico.png
font:
text: Source Han Sans SC
code: Roboto Mono
features:
- content.code.annotate
- content.code.copy
- content.code.select
- content.footnote.tooltips
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.instant.preview
- navigation.tabs
- navigation.top
- navigation.path
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
plugins:
- blog
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
- glightbox:
touchNavigation: true
loop: false
effect: zoom
slide_effect: slide
width: 100%
height: auto
zoomable: true
draggable: true
skip_classes:
- custom-skip-class-name
auto_caption: true
caption_position: bottom
background: white
shadow: true
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/extra.js
extra:
status:
new: Recently added
deprecated: Deprecated
analytics:
provider: google
property: G-XXXXXXXXXX
alternate:
# Switch to English
- name: English
#link: https://leverage.binbash.co
link: /en/
lang: en
# Switch to Chinese
- name: 简体中文
#link: https://leverage.binbash.co/zh/
link: /zh/
lang: zh
#===================================================================================#
# Mkdocs Markdown Extentions, Plugins & extras
#===================================================================================#
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __spanpymdownx.tilde
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
base_path:
- docs
check_paths: true
dedent_subsections: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
#===================================================================================#
# Mkdocs Navigation Tree
#===================================================================================#
nav:
- 首页: index.md
- 应用方案:
- solutions/index.md
- 多通道USB HiFi解码器解决方案: solutions/hifi_audio/multi_channel_usb_hifi_decoder_solution.md
- 便携USB低功耗HiFi解码器解决方案: solutions/hifi_audio/portable_usb_hifi_lowpower_decoder.md
- USB AI降噪直播麦克风解决方案: solutions/xu316_usb_ai/xu316_usb_ai_suoltion.md
- 核心模组:
- products/index.md
- USB HiFi解码器核心模组:
- products/hifi_audio/index.md
- HF87621(Q)-VB1: products/hifi_audio/hf87621_vb1.md
- HF87621(Q)-VC1: products/hifi_audio/hf87621_vc1.md
- HF87611(Q)-VB1: products/hifi_audio/hf87611_vb1.md
- HF87611(Q)-VC1: products/hifi_audio/hf87611_vc1.md
- HF86611(Q)-VB1: products/hifi_audio/hf86611_vb1.md
- HF86611(Q)-VC1: products/hifi_audio/hf86611_vc1.md
- HF83311(Q)-VB1: products/hifi_audio/hf83311_vb1.md
- HF83311(Q)-VC1: products/hifi_audio/hf83311_vc1.md
- USB低功耗HiFi解码器核心模组:
- products/phifi_audio/index.md
- PH83311L(Q)-VC1: products/phifi_audio/ph83311l_vc1.md
- PH83211L(Q)-VC1: products/phifi_audio/ph83211l_vc1.md
- PH73311L(Q)-VC1: products/phifi_audio/ph73311l_vc1.md
- PH73211L(Q)-VC1: products/phifi_audio/ph73211l_vc1.md
- USB直播麦克风核心模组:
- products/ai_mic/index.md
- LS67211-VC1: products/ai_mic/ls67211_vc1.md
- 虚拟7.1游戏声卡核心模组:
- products/game/index.md
- GM68311-VC1: products/game/gm68311_vc1.md
- GM67211-VC1: products/game/gm67211_vc1.md
# - 麦克风阵列:
# - products/array_mic/index.md
- Ai DNR深度降噪核心模组:
- products/ai_dnr/index.md
- DNR65211-VC1: products/ai_dnr/dnr65211_vc1.md
- DNR65221-VC1: products/ai_dnr/dnr65221_vc1.md
- DNR65231-VC1: products/ai_dnr/dnr65231_vc1.md
- USB OTG集成ASRC核心模组:
- products/usb_otg/index.md
- OT82111-VC1: products/usb_otg/ot82111_vc1.md
- OT83211-VC1: products/usb_otg/ot83211_vc1.md
- 音频采样率转换SRC核心模组:
- products/src/index.md
- XMSRC4392-VC1: products/src/xmsrc4392_vc1.md
- XMSRC4194-VC1: products/src/xmsrc4194_vc1.md
- XMSRC4192-VC1: products/src/xmsrc4192_vc1.md
- PDM到I2S/TDM转换核心模组:
- products/pdm_2_i2s/index.md
- XMAU7118-VC1: products/pdm_2_i2s/xmau7118_vc1.md
- 设计&开发:
- dev_doc/index.md
- 核心模组规格书:
- dev_doc/datasheet/index.md
- 通用核心模组:
- A316-1926-V1: dev_doc/datasheet/modules/a316_1926_v1_datasheet.md
- A316-Mini-V1: dev_doc/datasheet/modules/a316_mini_v1_datasheet.md
- A316-Codec-V1: dev_doc/datasheet/modules/a316_codec_v1_datasheet.md
- USB HiFi解码器核心模组:
- HF87621(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf87621_vb1.md
- HF87621(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf87621_vc1.md
- HF87611(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf87611_vb1.md
- HF87611(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf87611_vc1.md
- HF86611(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf86611_vb1.md
- HF86611(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf86611_vc1.md
- HF83311(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf83311_vb1.md
- HF83311(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf83311_vc1.md
- USB低功耗HiFi解码器核心模组:
- PH83311L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph83311l_vc1.md
- PH83211L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph83211l_vc1.md
- PH73311L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph73311l_vc1.md
- PH73211L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph73211l_vc1.md
# - USB直播麦克风核心模组:
# - dev_doc/datasheet/std_product/ai_mic/index.md
- 虚拟7.1游戏声卡核心模组:
- GM68311_VC1: dev_doc/datasheet/std_product/game/gm68311_vc1.md
- GM67211_VC1: dev_doc/datasheet/std_product/game/gm67211_vc1.md
# - 麦克风阵列:
# - dev_doc/datasheet/std_product/array_mic/index.md
- Ai DNR深度降噪核心模组:
- DNR65211-VC1: dev_doc/datasheet/std_product/ai_dnr/dnr65211_vc1.md
- DNR65221-VC1: dev_doc/datasheet/std_product/ai_dnr/dnr65221_vc1.md
- DNR65231-VC1: dev_doc/datasheet/std_product/ai_dnr/dnr65231_vc1.md
- USB OTG集成ASRC核心模组:
- OT82111_VC1: dev_doc/datasheet/std_product/usb_otg/ot82111_vc1.md
- OT83211_VC1: dev_doc/datasheet/std_product/usb_otg/ot83211_vc1.md
- 音频采样率转换SRC核心模组:
- XMSRC4392-VC1: dev_doc/datasheet/std_product/src/xmsrc4392_vc1.md
- XMSRC4194-VC1: dev_doc/datasheet/std_product/src/xmsrc4194_vc1.md
- XMSRC4192-VC1: dev_doc/datasheet/std_product/src/xmsrc4192_vc1.md
- PDM到I2S/TDM转换核心模组:
- XMAU7118-VC1: dev_doc/datasheet/std_product/pdm_2_i2s/xmau7118_vc1.md
- 开发评估板资源:
- dev_doc/evb/index.md
- A316-HF-DAC-V1:
- dev_doc/evb/a316_hf_dac_v1/index.md
- 低功耗测试指南: dev_doc/evb/a316_hf_dac_v1/LP_Testing_Guide.md
- 使用指南: dev_doc/evb/a316_hf_dac_v1/user_guide.md
- 测试指标: dev_doc/evb/a316_hf_dac_v1/test_spec.md
- 设计文件: dev_doc/evb/a316_hf_dac_v1/design_files.md
# - 授权指导: dev_doc/evb/a316_hf_dac_v1/a316_dac_auth_tool.md
- A316-PH-DAC-V1:
- 虚拟7.1游戏体验指南: dev_doc/evb/a316_ph_dac_v1/v71_game_play_guide.md
- 虚拟7.1空间音频原理及优势: dev_doc/evb/a316_ph_dac_v1/v71_sa_principles_advantages.md
- A316-HF-I2S-V1:
- dev_doc/evb/a316_hf_i2s_v1/index.md
- 硬件规格书: dev_doc/evb/a316_hf_i2s_v1/datasheet.md
- A316-LS-MIC-V2:
- dev_doc/evb/a316_ls_mic_v2/index.md
- 直播麦克风固件使用指南:
- 产品使用说明: dev_doc/evb/a316_ls_mic_v2/user_guide.md
- AI降噪效果演示: dev_doc/evb/a316_ls_mic_v2/dnr_effect.md
- OTG固件测试指南: dev_doc/evb/a316_ls_mic_v2/otg_firmware_test_guide.md
- A316-V71-Game-V1:
- dev_doc/evb/a316_v71_game_v1/index.md
- 使用指南: dev_doc/evb/a316_v71_game_v1/user_guide.md
- WiFi-Audio-TRX-V1:
- dev_doc/evb/wifi_8711_speaker/index.md
- 使用指南: dev_doc/evb/wifi_8711_speaker/user_guide.md
- Web配置指南: dev_doc/evb/wifi_8711_speaker/web_config_guide.md
- 固件烧录说明: dev_doc/evb/wifi_8711_speaker/firmware_flashing.md
- 硬件规格书: dev_doc/evb/wifi_8711_speaker/RTL8711dev_board.md
- 设计资料: dev_doc/evb/wifi_8711_speaker/design_docs.md
- 通信协议:
- dev_doc/protocols/index.md
- XU316 USB HiFi解码器免开发产品配置协议: dev_doc/protocols/xu316_zerocode_protocol.md
- XMOS EQ HID 通信协议规范: dev_doc/protocols/XMOS_EQ_HID_Protocol.md
- XMOS EQ UART 通信协议规范: dev_doc/protocols/XMOS_EQ_UART_Protocol.md
- 开发SDK与示例:
- dev_doc/sdk_examples/index.md
- A316免开发固件MCU开发指南:
- dev_doc/sdk_examples/XU316_MCU_Communication_Examples/index.md
- 代码示例:
- XU316与MCU通信协议命令宏定义: dev_doc/sdk_examples/XU316_MCU_Communication_Examples/Command_Macros.md
- XU316与MCU通信协议参考: dev_doc/sdk_examples/XU316_MCU_Communication_Examples/Command_Reference.md
- XU316音频接口控制: dev_doc/sdk_examples/XU316_MCU_Communication_Examples/Product_Content.md
- 免开发串口协议测试脚本说明: dev_doc/sdk_examples/XU316_MCU_Communication_Examples/ZeroCode_Test_Script.md
- 免开发固件开发问题指南: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md
# - 5.1标准固件使用示例:
# - 8711开发板连接说明: dev_doc/hifi_audio/a316_1926v1/RTL8711dome.md
# - 开发板硬件连接说明: dev_doc/hifi_audio/a316_1926v1/A316-8711-5.1解码无线音频套装制作说明.md
# - 电脑音频设备设置: dev_doc/hifi_audio/a316_1926v1/used.md
# - OTA工具使用说明: dev_doc/hifi_audio/a316_1926v1/OTA升级dongle-8711工具使用说明.md
- 常见问题问答:
- dev_doc/faq/index.md
- 产品常见问题:
- 电脑音频设备设置: dev_doc/hifi_audio/a316_1926v1/used.md
- 驱动识别与设备识别异常问题: dev_doc/faq/product_faq/driver_recognition_and_device_exception.md
# - 通用技术问答:
# - 免开发固件开发问题指南: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md
# - wifi音箱+蓝牙的模组技术问答: dev_doc/faq/technical_faq/technical_faq.md
- 服务&支持:
- services_support/index.md
- 配置及调试工具:
- services_support/tools_software/index.md
- 驱动程序:
- services_support/driver/index.md
- 产品固件下载:
- services_support/firmware/index.md
- 工厂固件下载:
- services_support/factory_img/index.md
- 咨询及服务:
- services_support/acquire_services/index.md
- 新闻动态:
- blog/index.md
- 关于我们:
- about_us/index.md
- 关于XMOS: about_us/xmos.md
- 加入我们: about_us/join_us.md
- 联系我们: about_us/contact_us.md