Package Options
An overview of Neural Sketch's global style keys and how to configure them
Read the Quick Start guide first for foundational usage concepts.
Introduction
Neural Sketch offers a variety of package-level options that allow you to fine-tune the visual style of your diagrams. By specifying these keys, you can unify the appearance of all blocks, containers, and text anchors globally across your document.
Usage
In most scenarios, you load the package in your preamble like so:
These options alter the baseline styles used for drawing shapes and applying transformations. For instance, you might enable dark-mode or modify container color defaults using:
In either case, the available style keys remain the same. The table below summarizes all recognized package options, their types, and default values:
Prop | Type | Default |
---|---|---|
block-border-color? | token list | nskDarkGray |
block-border-radius? | dimension | 2.5mm |
block-border-size? | dimension | .4mm |
block-embed-border-radius? | dimension | 1.3mm |
block-embed-padding? | dimension | 1mm |
block-fill? | token list | nskLightGray |
block-height? | dimension | 1cm |
block-width? | dimension | 1cm |
container-border-color? | token list | nskLighterGray |
container-fill? | token list | nskLightestGray |
container-padding? | dimension | .5cm |
container-rotate? | number | 0 |
container-scale? | number | 1 |
container-shift-x? | number | 0 |
container-shift-y? | number | 0 |
dark-mode? | boolean | false |
shadow? | boolean | {} |
text-center-loc? | token list | {} |
text-east-loc? | token list | {} |
text-north-loc? | token list | {} |
text-south-loc? | token list | {} |
text-west-loc? | token list | {} |