openFPGALoader/mkdocs.yml at master · xsession/openFPGALoader · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
site_name: openFPGALoader
site_description: Universal utility for programming FPGAs
site_url: https://xsession.github.io/openFPGALoader/
repo_name: xsession/openFPGALoader
repo_url: https://github.com/xsession/openFPGALoader
edit_uri: edit/master/docs/
theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist
  - tables
  - toc:
      permalink: true
plugins:
  - search
extra_javascript:
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js
  - javascripts/mermaid.js
nav:
  - Home: index.md
  - User guide:
      - First steps: guide/first-steps.md
      - Installation: guide/install.md
      - Advanced usage: guide/advanced.md
      - Troubleshooting: guide/troubleshooting.md
  - Compatibility:
      - Boards: compatibility/board.md
      - FPGAs: compatibility/fpga.md
      - Cables: compatibility/cable.md
  - Vendors:
      - Anlogic: vendors/anlogic.md
      - Cologne Chip: vendors/colognechip.md
      - Efinix: vendors/efinix.md
      - Gowin: vendors/gowin.md
      - Intel/Altera: vendors/intel.md
      - Lattice: vendors/lattice.md
      - Xilinx: vendors/xilinx.md
  - Hardware and debugging:
      - SOJ review: SOJ_REVIEW.md
      - Digilent HS3 vs XPCU: digilent-hs3-vs-xpcu-dump-flash-codepath.md
      - Spartan-6 XPCU debug: spartan6-xpcu-spi-debug-log.md
      - Spartan-6 HS3 write stall: spartan6-hs3-m25p40-write-stall.md
      - Xilinx Platform Cable USB: xilinx-platform-cable-usb-technical-reproduction.md
      - Windows Platform Cable USB: xilinx-platform-cable-usb-windows-debug.md
      - MachXO3 recovery: machxo3-recovery-after-bulk-erase.md
      - XCF platform flash: XCF_PLATFORM_FLASH.md
      - Windows cable notes: XILINX_PLATFORM_CABLE_USB_WINDOWS.md
  - Architecture:
      - Overview: architecture/index.md
      - Visual guide: architecture/visual-guide.md
      - Source map: architecture/source-map.md
      - Runtime flows: architecture/runtime-flows.md
      - Build and release: architecture/build-and-release.md
      - Architecture decisions: architecture/decisions.md
      - C4 context: architecture/c4/context.md
      - C4 containers: architecture/c4/containers.md
      - C4 components: architecture/c4/components.md
      - C4 deployment: architecture/c4/deployment.md
  - Contributing:
      - Architecture rules: contributing/architecture-rules.md
      - API and code reference: development/api-reference.md
  - Project documentation:
      - Device support: DEVICE_SUPPORT_CHAT.md
      - Adding a flash: adding-new-flash.md
      - Adding FPGA and flash support: adding-new-fpga-and-flash-guide.md
      - Deployment: DEPLOYMENT.md
      - Docker cross-Windows: DOCKER_CROSS_WINDOWS.md
      - Docker Linux deployment: DOCKER_DEPLOY_LINUX.md
      - CI issue report: development/ci-issues.md
      - Todo: todo.md