Neural Sketch

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:

\usepackage[<opts>]{neural-sketch}

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:

[
  dark-mode = true,
  block-fill = nskBlue,
  container-border-color = nskMidGray,
  ...
]

In either case, the available style keys remain the same. The table below summarizes all recognized package options, their types, and default values:

PropTypeDefault
block-border-color?token listnskDarkGray
block-border-radius?dimension2.5mm
block-border-size?dimension.4mm
block-embed-border-radius?dimension1.3mm
block-embed-padding?dimension1mm
block-fill?token listnskLightGray
block-height?dimension1cm
block-width?dimension1cm
container-border-color?token listnskLighterGray
container-fill?token listnskLightestGray
container-padding?dimension.5cm
container-rotate?number0
container-scale?number1
container-shift-x?number0
container-shift-y?number0
dark-mode?booleanfalse
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{}

On this page