glyphance/docs/config/glyphance.md
2022-11-21 15:40:16 +01:00

13 KiB

Config Schema

https://github.com/cupcakearmy/glyphance
Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none glyphance.schema.json

Config Type

object (Config)

Config Properties

Property Type Required Nullable Defined by
fonts object Optional cannot be null Config
output object Optional cannot be null Config
context string Optional cannot be null Config

fonts

fonts

  • is optional

  • Type: object (Details)

  • cannot be null

  • defined in: Config

fonts Type

object (Details)

output

output

  • is optional

  • Type: object (Details)

  • cannot be null

  • defined in: Config

output Type

object (Details)

context

context

  • is optional

  • Type: string

  • cannot be null

  • defined in: Config

context Type

string

Config Definitions

Definitions group fonts

Reference this group by using

{"$ref":"https://github.com/cupcakearmy/glyphance#/$defs/fonts"}
Property Type Required Nullable Defined by
^[a-zA-z \-_]+$ array Optional cannot be null Config

Pattern: ^[a-zA-z \-_]+$

^[a-zA-z \-_]+$

  • is optional

  • Type: object[] (Details)

  • cannot be null

  • defined in: Config

^[a-zA-z \-_]+$ Type

object[] (Details)

Definitions group font

Reference this group by using

{"$ref":"https://github.com/cupcakearmy/glyphance#/$defs/font"}
Property Type Required Nullable Defined by

Definitions group css

Reference this group by using

{"$ref":"https://github.com/cupcakearmy/glyphance#/$defs/css"}
Property Type Required Nullable Defined by
^ascent-override|descent-override|font-display|font-family|font-stretch|font-style|font-weight|font-feature-settings|font-variation-settings|line-gap-override|size-adjust|src|unicode-range$ string Optional cannot be null Config

Pattern: ^ascent-override|descent-override|font-display|font-family|font-stretch|font-style|font-weight|font-feature-settings|font-variation-settings|line-gap-override|size-adjust|src|unicode-range$

^ascent-override|descent-override|font-display|font-family|font-stretch|font-style|font-weight|font-feature-settings|font-variation-settings|line-gap-override|size-adjust|src|unicode-range$

  • is optional

  • Type: string

  • cannot be null

  • defined in: Config

^ascent-override|descent-override|font-display|font-family|font-stretch|font-style|font-weight|font-feature-settings|font-variation-settings|line-gap-override|size-adjust|src|unicode-range$ Type

string

Definitions group font-variation

Reference this group by using

{"$ref":"https://github.com/cupcakearmy/glyphance#/$defs/font-variation"}
Property Type Required Nullable Defined by
file string Optional cannot be null Config
variable boolean Optional cannot be null Config
css object Optional cannot be null Config

file

file

  • is optional

  • Type: string

  • cannot be null

  • defined in: Config

file Type

string

variable

variable

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Config

variable Type

boolean

css

css

  • is optional

  • Type: object (Details)

  • cannot be null

  • defined in: Config

css Type

object (Details)

Definitions group range

Reference this group by using

{"$ref":"https://github.com/cupcakearmy/glyphance#/$defs/range"}
Property Type Required Nullable Defined by

Definitions group output

Reference this group by using

{"$ref":"https://github.com/cupcakearmy/glyphance#/$defs/output"}
Property Type Required Nullable Defined by
dir string Optional cannot be null Config
prefix string Optional cannot be null Config
css object Optional cannot be null Config
clean boolean Optional cannot be null Config
formats array Optional cannot be null Config
ranges object Optional cannot be null Config

dir

dir

  • is optional

  • Type: string

  • cannot be null

  • defined in: Config

dir Type

string

prefix

prefix

  • is optional

  • Type: string

  • cannot be null

  • defined in: Config

prefix Type

string

css

css

  • is optional

  • Type: object (Details)

  • cannot be null

  • defined in: Config

css Type

object (Details)

clean

clean

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Config

clean Type

boolean

formats

formats

  • is optional

  • Type: string[]

  • cannot be null

  • defined in: Config

formats Type

string[]

ranges

ranges

  • is optional

  • Type: object (Details)

  • cannot be null

  • defined in: Config

ranges Type

object (Details)