wiki icon indicating copy to clipboard operation
wiki copied to clipboard

feat: add wireviz-web based wireviz syntax renderer

Open julled opened this issue 3 months ago • 0 comments

Add a renderer for wireviz syntax.

This renderer requires a wireviz-web server running / reachable via plugin definable url.

The renderer sends then the wireviz code to it and receives html which is inlined in the markdown code.

See README.md for more details.

Can be also used in existing setups using steps described in https://github.com/julled/wikijs-wireviz

Example:

image

Cable Harness Example


templates: # defining templates to be used later on
  - &molex_f
    type: Molex KK 254
    subtype: female
  - &con_i2c
    pinlabels: [GND, +5V, SCL, SDA]
  - &wire_i2c
    category: bundle
    gauge: 0.14 mm2
    colors: [BK, RD, YE, GN]

connectors:
  X1:
    <<: *molex_f # copying items from the template
    pinlabels: [GND, +5V, SCL, SDA, MISO, MOSI, SCK, N/C]
  X2:
    <<: *molex_f
    <<: *con_i2c # it is possible to copy from more than one template
  X3:
    <<: *molex_f
    <<: *con_i2c
  X4:
    <<: *molex_f
    pinlabels: [GND, +12V, MISO, MOSI, SCK]
  F:
    style: simple
    type: Crimp ferrule
    subtype: 0.25 mm²
    color: YE

cables:
  W1:
    <<: *wire_i2c
    length: 0.2
    show_equiv: true
  W2:
    <<: *wire_i2c
    length: 0.4
    show_equiv: true
  W3:
    category: bundle
    gauge: 0.14 mm2
    length: 0.3
    colors: [BK, BU, OG, VT]
    show_equiv: true
  W4:
    gauge: 0.25 mm2
    length: 0.3
    colors: [BK, RD]
    show_equiv: true

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]
  -
    - X1: [1-4]
    - W2: [1-4]
    - X3: [1-4]
  -
    - X1: [1,5-7]
    - W3: [1-4]
    - X4: [1,3-5]
  -
    - F.
    - W4: [1,2]
    - X4: [1,2]
 

julled avatar Oct 08 '25 14:10 julled