# Copyright (c) 2020 Michel Stempin # This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License # Project information site_name: FunKey Project Documentation site_author: Michel Stempin site_description: >- FunKey S - the world's smallest foldable handeld console Ultra-compact, foldable, powerful and comfortable, the FunKey S is the perfect handheld for playing retrogames anywhere, anytime. # Copyright copyright: > © 2020-2021 FunKey Project
Last updated on 2021-01-16
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. repo_url: 'https://github.com/FunKey-Project/FunKey-Project.github.io' edit_uri: '' # Configuration theme: name: material logo: assets/images/logo.png favicon: assets/favicon.png palette: primary: deep purple font: text: Roboto code: Roboto Mono # 404 page static_templates: - 404.html # Plugins plugins: - search - section-index - minify: minify_html: true - exclude: glob: - user_manual/tutorials/hardware/force_shutdown.md - user_manual/tutorials/software/restore_games.md - user_manual/tutorials/software/create_themes.md - redirects: redirect_maps: 'tutorials/software/gb_palette.md' : 'user_manual/tutorials/software/gb_palette.md' 'tutorials/software/gba_bios.md' : 'user_manual/tutorials/software/gba_bios.md' 'developers/hardware_ref/buttons.md' : 'developer_guide/hardware_reference/buttons.md' # Customization extra: social: - icon: fontawesome/brands/facebook link: https://www.facebook.com/FunKeyProjectOfficial - icon: fontawesome/brands/twitter link: https://twitter.com/FunKeyProject - icon: fontawesome/brands/instagram link: https://www.instagram.com/funkey_project/ - icon: fontawesome/brands/youtube link: https://www.youtube.com/channel/UCm6RThJXazA1VMhimqOtjww - icon: fontawesome/brands/pinterest link: https://www.pinterest.fr/davidlarbi/funkey-project/ - icon: fontawesome/brands/github link: https://github.com/FunKey-Project - icon: fontawesome/brands/docker link: https://hub.docker.com/r/funkeyproject/funkey-os/ # Custom CSS extra_css: - 'assets/css/custom.css' - 'assets/css/simple-lightbox.min.css' # Custom JS extra_javascript: - 'assets/js/jquery-3.5.1.min.js' - 'assets/js/simple-lightbox.jquery.min.js' - 'assets/js/custom.js' # Extensions markdown_extensions: - admonition - abbr - attr_list - def_list - footnotes - meta - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.critic - pymdownx.details - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg - pymdownx.highlight - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: repo_url_shorthand: true user: FunKey-Project repo: FunKey-Project.github.io - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets: check_paths: true - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed - pymdownx.tasklist: custom_checkbox: true clickable_checkbox: true - pymdownx.tilde # Page tree nav: - 'Overview': 'index.md' - "User's Manual": - 'Quickstart': 'user_manual/quickstart.md' - Product Description: - 'Key Mapping': 'user_manual/features/key_mapping.md' - 'Launchers': 'user_manual/features/launchers.md' - 'Emulators': 'user_manual/features/emulators.md' - 'Standalone Games & Applications': 'user_manual/features/games_apps.md' - 'FunKey Menu': 'user_manual/features/funkey_menu.md' - 'Folder Organization': 'user_manual/features/folder_organization.md' - 'Quick Save': 'user_manual/features/quick_save.md' - 'Instant Action': 'user_manual/features/instant_action.md' - 'Hardware Characteristics' : 'user_manual/features/hardware_characteristics.md' - 'Open Source' : 'user_manual/features/open_source.md' - Tutorials: - Software: - 'Add New ROMs': 'user_manual/tutorials/software/add_roms.md' - 'Add OPK Files': 'user_manual/tutorials/software/add_opk.md' - 'Install the GBA/PS1 BIOS': 'user_manual/tutorials/software/gba_bios.md' - 'Change Aspect Ratio': 'user_manual/tutorials/software/aspect_ratio.md' - 'Take a Snapshot': 'user_manual/tutorials/software/snapshot.md' - 'Firmware Upgrade': 'user_manual/tutorials/software/firmware_update.md' - 'Change Gameboy Palette': 'user_manual/tutorials/software/gb_palette.md' - 'Change Gmenu2x Wallpaper': 'user_manual/tutorials/software/gmenu2x_wallpaper.md' # - 'Create Themes': 'user_manual/tutorials/software/create_themes.md' #- 'Restore Default Games & Emulators': 'user_manual/tutorials/software/restore_games.md' - Hardware: - 'Teardown': 'user_manual/tutorials/hardware/teardown.md' - 'Flash & Change micro-SD Card': 'user_manual/tutorials/hardware/flash_change_sd_card.md' - 'Change the Buttons': 'user_manual/tutorials/hardware/change_buttons.md' - '': 'user_manual/tutorials/hardware/fix_unstuck_screen.md' # - 'Force Shutdown': 'user_manual/tutorials/hardware/force_shutdown.md' - Developer's Guide: - Hardware Reference: - 'developer_guide/hardware_reference/index.md' - 'Architecture': 'developer_guide/hardware_reference/architecture.md' - 'BOM': 'https://htmlpreview.github.io/?https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/BOM/ibom.html' - 'CPU': 'developer_guide/hardware_reference/cpu.md' - Power: - 'Regulated DC Power Supply Topologies': 'developer_guide/hardware_reference/power/power_supplies_topologies.md' - 'Multiple Power Supply Voltages': 'developer_guide/hardware_reference/power/multiple_voltages.md' - 'PMIC': 'developer_guide/hardware_reference/power/pmic.md' - 'DRAM Power': 'developer_guide/hardware_reference/power/dram_power.md' - 'Decoupling' : 'developer_guide/hardware_reference/power/decoupling.md' - 'Screen': 'developer_guide/hardware_reference/screen.md' - 'Audio': 'developer_guide/hardware_reference/audio.md' - 'Buttons': 'developer_guide/hardware_reference/buttons.md' - 'SD Card': 'developer_guide/hardware_reference/sd-card.md' - 'USB': 'developer_guide/hardware_reference/usb.md' - 'UART': 'developer_guide/hardware_reference/uart.md' - 'Magnetic Switch': 'developer_guide/hardware_reference/magnetic_switch.md' - Software Reference: - 'developer_guide/software_reference/index.md' - Boot Process: - 'developer_guide/software_reference/boot_process/index.md' - 'Boot ROM': 'developer_guide/software_reference/boot_process/boot_rom.md' - 'SPL': 'developer_guide/software_reference/boot_process/spl.md' - 'U-Boot Bootloader': 'developer_guide/software_reference/boot_process/bootloader.md' - 'Linux Kernel': 'developer_guide/software_reference/boot_process/kernel.md' - 'System V Init Scripts': 'developer_guide/software_reference/boot_process/init_scripts.md' - 'Shutdown Process': 'developer_guide/software_reference/boot_process/shutdown_process.md' - SD-Card Layout: - 'developer_guide/software_reference/sd_card_layout/index.md' - 'Partition Map': 'developer_guide/software_reference/sd_card_layout/partition_map.md' - 'Recovery Partition': 'developer_guide/software_reference/sd_card_layout/recovery_partition.md' - 'Root Filesystem Partition': 'developer_guide/software_reference/sd_card_layout/root_filesystem_partition.md' - 'USB Shared Partition': 'developer_guide/software_reference/sd_card_layout/usb_shared_partition.md' - 'Video Processing': 'developer_guide/software_reference/video_processing.md' - 'Input Mapping': 'developer_guide/software_reference/input_mapping.md' - Tutorials: - 'Access the Recovery Boot Mode': 'developer_guide/tutorials/access_recovery.md' - 'SSH Connection over USB': 'developer_guide/tutorials/ssh_connection.md' - 'Serial Connection over UART': 'developer_guide/tutorials/uart_connection.md' - Build System: - 'developer_guide/tutorials/build_system/index.md' - 'Compilation Environments': 'developer_guide/tutorials/build_system/compilation_environments.md' - 'Get the Sources': 'developer_guide/tutorials/build_system/get_sources.md' - 'Compile SDK': 'developer_guide/tutorials/build_system/compile_sdk.md' - 'Compile Distribution': 'developer_guide/tutorials/build_system/compile_distribution.md' - 'Write firmware to SD Card': 'developer_guide/tutorials/build_system/write_image.md' - 'Build Programs using SDK': 'developer_guide/tutorials/build_system/build_program_using_sdk.md' - '3D files': 'https://grabcad.com/library/funkey-s-1' - Miscellaneous: - 'Glossary': 'miscellaneous/glossary.md' - 'FAQ': 'miscellaneous/faq.md'