Fretboard Syntax Guide

tags: docs

This page is under construction

This feature is available after CodiMD 2.2.0 and HackMD EE 1.19

Concept

Input data like:

```fretboard {title="horizontal, 5 frets", type="h6 noNut"}
-oO-*-
--o-o-
-o-oo-
-o-oO-
-oo-o-
-*O-o-
```

will render:

-oO-*-
--o-o-
-o-oo-
-o-oO-
-oo-o-
-*O-o-

Syntax

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
2. numbers (optional) type 1-9 to stands for the fret number.

Examples

-oO-*-
--o-o-
-o-oo-
-o-oO-
-oo-o-
-*O-o-
  3

-oO-*-
--o-o-
-o-oo-
-o-oO-
-oo-o-
-*O-o-
  8

-oO-*
--o-o
-o-oo
-o-oO
-oo-o
-*O-o
  8

   ^^  
 ||||||
 |o||||
 o|||oo
 ||||||

 x    x
 ||||o|
 ||o|||
7|o|o||
 ||||||

 xx^   
 ||||||
 |||o|*
 ||||o|
 ||||||
 |||||o

 x     
 ||||||
 ||||||
3||||||
 |(===)
5||||o|
 ||oo||
 ||||||

 x    x
 ||||||
 ||||||
3||||||
 ||||||
5||||||
 |(==)|
7||||||
 ||(=)|
9||||||

 xx    
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||o|
9|||o||
 ||o||o
 ||||||
 ||||||

 xxx x 
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 ||||||
 |||o|o
 ||||||