310 lines
11 KiB
YAML
310 lines
11 KiB
YAML
# ref link: https://alinex.gitlab.io/env/mkdocs/
|
|
#===================================================================================#
|
|
# Site Information
|
|
#===================================================================================#
|
|
site_name: Phaten Audio | XMOS AI Professional Audio Solutions Provider | OFFICIAL VALUE-ADDED RESELLER OF XMOS LIMITED
|
|
site_description: Shenzhen Phaten Technology Co., Ltd. - OFFICIAL VALUE-ADDED RESELLER OF XMOS LIMITED
|
|
site_author: Phaten
|
|
site_dir: '../../site/en'
|
|
copyright: Copyright © 2024 <a href="https://www.phaten-audio.com">Shenzhen Phaten Technology Co., Ltd.</a>
|
|
site_login: true
|
|
login_name: Login/Register
|
|
login_url: /en/login
|
|
|
|
#===================================================================================#
|
|
# Mkdocs Theme (Material Mkdocs) + Extras
|
|
#===================================================================================#
|
|
theme:
|
|
name: material
|
|
custom_dir: material/templates
|
|
language: en
|
|
logo: assets/images/logos/phaten-logo-cn.png
|
|
favicon: assets/images/logos/phaten-logo-ico.png
|
|
font:
|
|
text: Roboto
|
|
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: !ENV GOOGLE_ANALYTICS_KEY
|
|
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
|
|
- 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:
|
|
- Home: index.md
|
|
|
|
- Product:
|
|
- products/index.md
|
|
- Hardware Modules:
|
|
- products/modules/index.md
|
|
- A316-1926-V1: products/modules/a316_1926v1.md
|
|
- A316-Mini-V1: products/modules/a316-mini.md
|
|
- A316-Codec-V1: products/modules/a316_codec_v1.md
|
|
- ZeroCode Products:
|
|
- products/std_product/index.md
|
|
- USB HiFi Decoder:
|
|
- products/hifi_audio/index.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 Low-Power HiFi Decoder:
|
|
- 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 Live Streaming Microphone:
|
|
# - products/ai_mic/index.md
|
|
# - USB Gaming Headset:
|
|
# - products/game/index.md
|
|
# - GM68321-VC1: products/game/gm68321l_vc1.md
|
|
# - Microphone Array:
|
|
# - products/array_mic/index.md
|
|
- USB V7.1 Gaming SoundCard:
|
|
- products/game/index.md
|
|
- GM68311-VC1: products/game/gm68311_vc1.md
|
|
- USB OTG:
|
|
- products/usb_otg/index.md
|
|
- OT82111-VC1: products/usb_otg/ot82111_vc1.md
|
|
# - Interface Conversion:
|
|
# - products/src/index.md
|
|
- Development&Evaluation Boards:
|
|
- products/evb/index.md
|
|
- A316-HF-DAC-V1: products/evb/a316_hf_dac_v1.md
|
|
- A316-HF-I2S-V1: products/evb/a316_hf_i2s_v1.md
|
|
- A316-LS-MIC-V2: products/evb/a316_ls_mic_v2.md
|
|
- A316-V71-Game-V1: products/evb/a316_v71_game_v1.md
|
|
- XK-AUDIO-316-MC-AB: products/evb/xk_audio_316_mc_ab.md
|
|
- XVF3800 EVALUATION KIT: products/evb/xk_voice_sq66.md
|
|
- XK-VOICE-L71: products/evb/xk_voice_l71.md
|
|
|
|
|
|
- Application:
|
|
- solutions/index.md
|
|
- Multi-Channel USB HiFi Decoder Solution: solutions/hifi_audio/multi_channel_usb_hifi_decoder_solution.md
|
|
- Portable USB Low-Power HiFi Decoder Solution: solutions/hifi_audio/portable_usb_hifi_lowpower_decoder.md
|
|
- USB AI Noise Reduction Streaming Microphone Solution: solutions/xu316_usb_ai/xu316_usb_ai_suoltion.md
|
|
|
|
|
|
- Documentation:
|
|
- dev_doc/index.md
|
|
- Product Datasheet:
|
|
- dev_doc/datasheet/index.md
|
|
- Hardware Module Datasheet:
|
|
- 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
|
|
- ZeroCode Product Datasheet:
|
|
- USB HiFi Decoder:
|
|
- 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 Low-Power HiFi Decoder:
|
|
- 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 Live Streaming Microphone:
|
|
# - dev_doc/datasheet/std_product/ai_mic/index.md
|
|
# - USB Gaming Headset:
|
|
# - GM68321L: dev_doc/datasheet/std_product/gm68321l_vc1.md
|
|
# - Microphone Array:
|
|
# - dev_doc/datasheet/std_product/array_mic/index.md
|
|
- USB V7.1 Gaming SoundCard:
|
|
- GM68311: dev_doc/datasheet/std_product/game/gm68311_vc1.md
|
|
- USB OTG:
|
|
- OT82111_VC1: dev_doc/datasheet/std_product/usb_otg/ot82111_vc1.md
|
|
# - Interface Conversion:
|
|
# - dev_doc/datasheet/std_product/src/index.md
|
|
- Development&Evaluation Board Resources:
|
|
- dev_doc/evb/index.md
|
|
- A316-HF-DAC-V1:
|
|
- Low Power Consumption Testing Guide: dev_doc/evb/a316_hf_dac_v1/LP_Testing_Guide.md
|
|
- User Guide: dev_doc/evb/a316_hf_dac_v1/user_guide.md
|
|
- Test Specifications: dev_doc/evb/a316_hf_dac_v1/test_spec.md
|
|
- Design Files: dev_doc/evb/a316_hf_dac_v1/design_files.md
|
|
- A316-HF-I2S-V1:
|
|
- Hardware Specifications: dev_doc/evb/a316_hf_i2s_v1/datasheet.md
|
|
- A316-LS-MIC-V2:
|
|
- Live Microphone Firmware Usage Guide:
|
|
- User Guide: dev_doc/evb/a316_ls_mic_v2/user_guide.md
|
|
- AI Noise Reduction Effect: dev_doc/evb/a316_ls_mic_v2/dnr_effect.md
|
|
- OTG Firmware Test Guide: dev_doc/evb/a316_ls_mic_v2/otg_firmware_test_guide.md
|
|
- A316-V71-Game-V1:
|
|
- User Guide: dev_doc/evb/a316_v71_game_v1/user_guide-en.md
|
|
|
|
- Communication Protocols:
|
|
- dev_doc/protocols/index.md
|
|
- XU316 USB HiFi Decoder ZeroCode Product Configuration Protocol: dev_doc/protocols/xu316_zerocode_protocol.md
|
|
- Development SDK and Examples:
|
|
- dev_doc/sdk_examples/index.md
|
|
- A316 Firmware-Free MCU Development Guide:
|
|
- A316 Series Product Firmware Development FAQ: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md
|
|
- Command Macros: dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令的相关宏.md
|
|
- Command Reference: dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令相关.md
|
|
- XU316 Audio Interface Control Code Example: dev_doc/sdk_examples/XU316和MCU通讯的示例代码/产品内容相关.md
|
|
- FQAs:
|
|
- dev_doc/faq/index.md
|
|
- Product FAQs:
|
|
- Computer audio device settings: dev_doc/hifi_audio/a316_1926v1/used_en.md
|
|
# - General Technical Q&A:
|
|
# - WiFi Audio + Bluetooth Module: dev_doc/faq/technical_faq/technical_faq.md
|
|
|
|
- Services & Support:
|
|
- services_support/index.md
|
|
- Configuration and Debugging Tools:
|
|
- services_support/tools_software/index.md
|
|
- Drivers:
|
|
- services_support/driver/index.md
|
|
- Product Firmware Downloads:
|
|
- services_support/firmware/index.md
|
|
- Factory Firmware Downloads:
|
|
- services_support/factory_img/index.md
|
|
- Consultation and Services:
|
|
- services_support/acquire_services/index.md
|
|
|
|
- News:
|
|
- blog/index.md
|
|
|
|
|
|
- About Us:
|
|
- about_us/index.md
|
|
- About XMOS: about_us/xmos.md
|
|
- Join Us: about_us/join_us.md
|
|
- Contact Us: about_us/contact_us.md |