# Fretboard Syntax Guide ###### tags: `docs` :::warning :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: This page is under construction :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: **This feature is available after CodiMD 2.2.0 and HackMD EE 1.19** ::: ## Concept Input data like: ~~~md ```fretboard {title="horizontal, 5 frets", type="h6 noNut"} -oO-*- --o-o- -o-oo- -o-oO- -oo-o- -*O-o- ``` ~~~ will render: ```fretboard {title="horizontal, 5 frets", type="h6 noNut"} -oO-*- --o-o- -o-oo- -o-oO- -oo-o- -*O-o- ``` ## Syntax :::info fretboard {title="fretboardTitle", type="element0 element1"} ::: Use brace bar to contain **title** and **type**. ### title first parameter, to describe fretboard title in double quotes. ### type second parameter, made by **fretboard type** and **nut**. 1. fretboard type, supporting for: 1. **vertical**: code: `v4`, `v5`, `v7`, `v9`, `v12`, `v15` stands for fret 4, 5, 7, 9, 12 and 15. 2. **horizontal**: code: `h5`, `h6` stands for fret 5 and 6. 2. **Nut** (optional) : default value is with nut. type `noNut` if you don't want to show nut. ex. `type="h6 noNut"` ### ascii fret Made by 2 parts, **ascii fret** and **numbers**. 1. **ascii fret** read more in [ascii fret](https://github.com/birdca/fretboard#basic-ascii-to-svg-setup) 2. **numbers** (optional) type 1-9 to stands for the fret number. ## Examples ```fretboard {title="horizontal, 6 frets, with nut", type="h6"} -oO-*- --o-o- -o-oo- -o-oO- -oo-o- -*O-o- 3 ``` ```fretboard {title="horizontal, 6 frets, noNut", type="h6 noNut"} -oO-*- --o-o- -o-oo- -o-oO- -oo-o- -*O-o- 8 ``` ```fretboard {title="horizontal, 5 frets, noNut", type="h5 noNut"} -oO-* --o-o -o-oo -o-oO -oo-o -*O-o 8 ``` ```fretboard {title="vertical, 4 frets", type="v4"} ^^ |||||| |o|||| o|||oo |||||| ``` ```fretboard {title="vertical, 4 frets, no nut", type="v4 noNut"} x x ||||o| ||o||| 7|o|o|| |||||| ``` ```fretboard {title="vertical, 5 frets", type="v5"} xx^ |||||| |||o|* ||||o| |||||| |||||o ``` ```fretboard {title="vertical, 7 frets", type="v7"} x |||||| |||||| 3|||||| |(===) 5||||o| ||oo|| |||||| ``` ```fretboard {title="vertical, 9 frets", type="v9"} x x |||||| |||||| 3|||||| |||||| 5|||||| |(==)| 7|||||| ||(=)| 9|||||| ``` ```fretboard {title="vertical, 12 frets", type="v12"} xx |||||| |||||| |||||| |||||| |||||| |||||| |||||| ||||o| 9|||o|| ||o||o |||||| |||||| ``` ```fretboard {title="vertical, 15 frets", type="v15"} xxx x |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||||| |||o|o |||||| ```