mkdocs.yml

site_name: ORIX v2025.3 DOCUMENTATION

markdown_extensions:
    - pymdownx.highlight
    - pymdownx.inlinehilite
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.snippets
    - pymdownx.critic
    - pymdownx.caret
    - pymdownx.keys
    - pymdownx.mark
    - pymdownx.tilde
    - attr_list
    - md_in_html
    - admonition
    - pymdownx.details
    - pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
    - tables
    - pymdownx.emoji:
        emoji_index: !!python/name:materialx.emoji.twemoji
        emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
 - git-revision-date
 - search
 - markmap
 - mkdocs-video

#   - mkdocstrings:
#         watch:
#             - src/project

dev_addr: '172.30.72.43:8001'

theme:
    name: material
    logo: favicon.png
    custom_dir: overrides
    highlightjs: true
    palette:
        primary: black
        scheme: default
    features:
        - navigation.tabs
        - navigation.top
        - content.tabs.link

nav:
    - Home:
        - Introduction: index.md
        - Hardware: hardware.md
        - Software: software.md

    #     - User manual: user_manual/overview.md
    #     - Developer manual: developer_manual/index.md
    - User manual:
        - Quick start : user_manual/quickstart.md
        - Features: user_manual/features.md
        - Overview: user_manual/overview.md
        - Commands:
            - All commands: commands/all.md
            - asm2k2: commands/asm2k2.md
            - bank: commands/bank.md
            - basic10: commands/basic10.md
            - basic11: commands/basic11.md
            - barboric: commands/barboric.md
            - blakes7: commands/blakes7.md
            - bootfd: commands/bootfd.md
            - born1983: commands/born1983.md
            - cat: commands/cat.md
            - cd: commands/cd.md
            - cksum: commands/cksum.md
            - clear: commands/clear.md
            - cp: commands/cp.md
            - df: commands/df.md
            - otimer: commands/otimer.md
            - dsk-util: commands/dsk-util.md
            - echo: commands/echo.md
            - env: commands/env.md
            - forth: commands/forth.md
            - ftdos: commands/ftdos.md
            - grep: commands/grep.md
            - help: commands/help.md
            - hexdump: commands/hexdump.md
            - ioports: commands/ioports.md
            - list: commands/list.md
            - ls: commands/ls.md
            - lscpu: commands/lscpu.md
            - lsmem: commands/lsmem.md
            - loader: commands/loader.md
            - man: commands/man.md
            - mkdir: commands/mkdir.md
            - more: commands/more.md
            - mount: commands/mount.md
            - orixcfg: commands/orixcfg.md
            - pwd: commands/pwd.md
            - ps: commands/ps.md
            - quintes: commands/quintes.md
            - raw2dsk: commands/raw2dsk.md
            - readdsk: commands/readdsk.md
            - reboot: commands/reboot.md
            - rm: commands/rm.md
            - sedoric: commands/sedoric.md
            - setfont: commands/setfont.md
            - sh: commands/sh.md
            - sterr: commands/strerr.md
            - submit: commands/submit.md
            - telstrat: commands/telstrat.md
            - touch: commands/touch.md
            - twil: commands/twil.md
            - twiload: commands/twiload.md
            - uname: commands/uname.md
            - untar: commands/untar.md
            - vi: commands/vi.md
            - vidplay: commands/vidplay.md
            - viewscr: commands/viewscr.md
            - viewhrs: commands/viewhrs.md
            - zerofx: commands/zerofx.md
        - Twilighte board: user_manual/hardware/index.md
        # - Floppy drive commands:
        #     - Bootfd: user_manual/bootfd.md
        # - Shell guide :
        #     - Basic 11 commands: how-it-work/index.md
        - Software loader: user_manual/loader.md
        - Hardware manuals:
            - Ribbon cable: hardware/nappe.md
            - Plug voice synthetizer: hardware/synth_vocal_mea80900.md
            - Oric incompatibility: hardware/incompatibility_oric.md
            - Hardware issues: hardware/hardware_issues.md
            - Sdcard over wifi: user_manual/devices/sdcard_reader_over_wifi.md
        - Tutorials:
            - Scripting (simple): tutorials/submit_scripts.md
            - Autoboot : tutorials/autoboot_fr.md
            - Submit scripts: tutorials/advanced_submit_part1
        - Updates:
            - 2025.3: update/2025_3.md
            - 2024.1: update/2024_1.md
            - 2023.3: update/2023_3.md
            - 2023.2: update/2023_2.md
            - 2023.1: update/2023_1.md
            - 2022.4: update/2022_4.md
            - 2022.3: update/2022_3.md
            - commands:
                - File: update/file/file.md
    - Developer manual:
        - Changes: developer_manual/index.md
        - Install: developer_manual/first_step.md
        - Tutorials:
            - hello world: developer_manual/tutorials/print_string.md
        - Development guidelines: developer_manual/guidelines.md
        - Memory management : developer_manual/memory.md
        - Bank signature : developer_manual/bank_signature.md
        - Dynamic libraries: developer_manual/dynamic_libraries.md
        - Build an Orix rom : developer_manual/buildrom.md
        - Build standalone Rom : developer_manual/buildstandalonerom.md
        - Generate a binary for sdcard/usb key: binaries/generateBinary.md
        - SDK for Assembly (Orixsdk):
            - Overview: developer_manual/orixsdk_macros/overview.md
            - Main usage: developer_manual/orixsdk.md
            - File operations:
                - fopen: developer_manual/orixsdk_macros/fopen.md
                - fread: developer_manual/orixsdk_macros/fread.md
                - fwrite: developer_manual/orixsdk_macros/fwrite.md
                - fseek: developer_manual/orixsdk_macros/fseek.md
                - fclose: developer_manual/orixsdk_macros/fclose.md
                - mkdir: developer_manual/orixsdk_macros/mkdir.md
                - chdir: developer_manual/orixsdk_macros/chdir.md
                - getcwd: developer_manual/orixsdk_macros/getcwd.md
                - unlink: developer_manual/orixsdk_macros/unlink.md
            - Text mode operations:
                - print: developer_manual/orixsdk_macros/print.md
                - prints: developer_manual/orixsdk_macros/prints.md
                - print_int: developer_manual/orixsdk_macros/print_int.md
                - cputc: developer_manual/orixsdk_macros/cputc.md
                - crlf: developer_manual/orixsdk_macros/crlf.md
                - scroll: developer_manual/orixsdk_macros/scroll.md
                - cursor: developer_manual/orixsdk_macros/cursor.md
                - setscreen: developer_manual/orixsdk_macros/setscreen.md
            - Memory operations:
                - malloc: developer_manual/orixsdk_macros/malloc.md
                - mfree: developer_manual/orixsdk_macros/mfree.md
                - memdecal: developer_manual/orixsdk_macros/memdecal.md
                - memmove: developer_manual/orixsdk_macros/memmove.md
            - Strings operations:
                - strncat: developer_manual/orixsdk_macros/strncat.md
                - strncpy: developer_manual/orixsdk_macros/strncpy.md
            - Command line operations:
                - initmainargs: developer_manual/orixsdk_macros/initmainargs.md
                - getmainargs: developer_manual/orixsdk_macros/getmainargs.md
            - Keyboards operations:
                - cgetc: developer_manual/orixsdk_macros/cgetc.md
            - Process operations:
                - exec: developer_manual/orixsdk_macros/exec.md
            - Number operations:
                - atoi: developer_manual/orixsdk_macros/atoi.md
                - tohex: developer_manual/orixsdk_macros/tohex.md
                - print_int: developer_manual/orixsdk_macros/print_int.md
                - itoa: developer_manual/orixsdk_macros/itoa.md
            - Sound operations:
                - shoot: developer_manual/orixsdk_macros/shoot.md
                - ping: developer_manual/orixsdk_macros/ping.md
                - zap: developer_manual/orixsdk_macros/zap.md
                - explode: developer_manual/orixsdk_macros/explode.md
        - Generate man pages : developer_manual/buildman.md
        - cc65 : developer_manual/cc65.md
        - Binary and dynamic library header format : developer_manual/header.md
        - Joysticks management : developer_manual/joysticks.md
        - Cross development on real hardware : developer_manual/pizero_connection.md
        - Oricutron VS real hardware : developer_manual/oricutronvsreal.md
        - Kernel guide:
            - Kernel: developer_manual/kernel.md
            - Memmap: developer_manual/kernel/memmap.md
            - Notebook: developer_manual/notebook.md
            - Primitives:
                - General list : developer_manual/kernel/primitives/index.md
                - By category:
                    - Command line args:
                        - XMAINARGS: developer_manual/kernel/primitives/xmainargs.md
                        - XGETARGV: developer_manual/kernel/primitives/xgetargv.md
                    - Files operations:
                        - XOPEN: developer_manual/kernel/primitives/xopen.md
                        - XCLOSE: developer_manual/kernel/primitives/xclose.md
                        - XFREAD: developer_manual/kernel/primitives/xfread.md
                        - XWRITE: developer_manual/kernel/primitives/xwrite.md
                        - XFSEEK: developer_manual/kernel/primitives/xfseek.md
                        - XRM: developer_manual/kernel/primitives/xrm.md
                        - XMKDIR: developer_manual/kernel/primitives/xmkdir.md
                        - XCLOSEDIR: developer_manual/kernel/primitives/xclosedir.md
                        - XOPENDIR: developer_manual/kernel/primitives/xopendir.md
                    - Memory operations:
                        - XMALLOC: developer_manual/kernel/primitives/xmalloc.md
                        - XFREE: developer_manual/kernel/primitives/xfree.md
                        - XBANK: developer_manual/kernel/primitives/xbank.md
                    - Process Operations:
                        - XEXEC: developer_manual/kernel/primitives/xexec.md
                    - Keyboard Operations:
                        - XRDW0: developer_manual/kernel/primitives/xrdw0.md
                        - XRD0: developer_manual/kernel/primitives/xrd0.md
                    - Textmode Operations:
                        - XSCROB: developer_manual/kernel/primitives/xscrob.md
                        - XSCROH: developer_manual/kernel/primitives/xscroh.md
                        - XCRLF: developer_manual/kernel/primitives/xcrlf.md
                        - XWR0: developer_manual/kernel/primitives/xwr0.md
                        - XWSTR0: developer_manual/kernel/primitives/xwstr0.md
                    - Numbers Operations:
                        - XBINDX: developer_manual/kernel/primitives/xbindx.md
                        - XDECIM: developer_manual/kernel/primitives/xdecim.md
                        - XDECAY: developer_manual/kernel/primitives/xdecay.md
                        - XHEXA: developer_manual/kernel/primitives/xhexa.md
                    - Kernel variables Operations:
                        - XVALUES: developer_manual/kernel/primitives/xvalues.md
                        - XVARS: developer_manual/kernel/primitives/xvars.md
            - Binary boot sequence: developer_manual/binary_starts.md
        - Hardware guide :
            - Memory: hardware/memory.md
            - I/O: hardware/i_o.md
            - Firmware informations : developer_manual/firmware.md
            - Joysticks: hardware/joysticks.md
            - Eeprom structure: hardware/eeprom_structure.md
        - Extra Libs :
            - Twilighte library lib: "https://orix-software.github.io/twillib/api/"
            - RTC lib: "https://orix-software.github.io/ds1501lib/api/"
            - USB controler lib: "https://orix-software.github.io/ch376lib/api/"
            - Inetlib: "https://orix-software.github.io/inetlib/api/"
            - Ethernet Controler lib: "https://orix-software.github.io/ch395lib/api/"
            - Progress bar lib: "https://orix-software.github.io/pbarlib/api/"
            - Memcache lib: "https://orix-software.github.io/pbarlib/api/"
            - Curl lib: "https://orix-software.github.io/curllib/api/"
            - Socket lib: "https://orix-software.github.io/socketlib/api/"
extra_css:
    - stylesheets/extra.css
extra:
    social:
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/OrixTwil
        - icon: fontawesome/brands/youtube
          link: https://www.youtube.com/user/jede06600/videos