Skip to content
NeoAbs Documentation Configuration

Configuration

NeoAbs is configured through the theme key in your mkdocs.yml.

Basic setup

site_name: My Docs
theme:
  name: neoabs

Full configuration

site_name: My Docs
theme:
  name: neoabs
  favicon: assets/images/favicon.svg
  language: en
  direction: ltr
  palette:
    - scheme: slate
      primary: black
      accent: red
      toggle:
        name: Switch to light mode
    - scheme: default
      primary: white
      accent: red
      toggle:
        name: Switch to dark mode
  font:
    text: Space Grotesk
    code: Space Mono
  features:
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - search.suggest
    - search.highlight
  neoabs:
    glass: medium
    dot_matrix: true
    animation: normal
    border: thin

plugins:
  - search
  - neoabs

Options reference

palette

Controls the color scheme and toggle behavior. Uses MkDocs' standard palette system.

palette:
  - scheme: slate       # dark mode
    primary: black
    accent: red
    toggle:
      name: Switch to light mode
  - scheme: default     # light mode
    primary: white
    accent: red
    toggle:
      name: Switch to dark mode
Option Values Description
scheme "slate", "default" Color scheme (slate = dark, default = light)
primary "black", "white" Primary background tone
accent "red" Accent color (Nothing Red)
toggle.name string Label for the toggle button

neoabs.glass

Sets the global glass intensity. This controls backdrop-filter blur and transparency on panels, cards, and navigation.

Value Blur Saturation Background opacity Effect
"light" 10px 1.0 5% Subtle blur, high transparency
"medium" 20px 1.2 8% Balanced blur and opacity (default)
"heavy" 30px 1.4 12% Strong blur, lower transparency 
neoabs:
  glass: heavy

neoabs.dot_matrix

Enables or disables the dot matrix background pattern behind content.

neoabs:
  dot_matrix: true

Warning

Disabling dot_matrix removes the background texture. The theme still works, but loses a signature visual element.

neoabs.border

Controls the border style on glass panels.

Value Description
"thin" 1px semi-transparent borders (default)
"thick" 2px borders
"none" No borders on glass panels 
neoabs:
  border: thin

neoabs.animation

Controls entrance and hover animations.

Value Description
"normal" Enable animations (default)
"none" Disable all animations 
neoabs:
  animation: normal

Note

Animations are automatically disabled when the user has prefers-reduced-motion: reduce set in their OS.

font

Override the default typefaces.

font:
  text: Space Grotesk
  code: Space Mono

Tip

The fonts are loaded from Google Fonts automatically. You can self-host by overriding the CSS and providing your own @font-face rules.

features

MkDocs feature flags that NeoAbs supports:

  • navigation.sections — Group navigation items by section
  • navigation.top — Back-to-top button
  • navigation.footer — Previous/next navigation in footer
  • content.code.copy — Copy button on code blocks
  • search.suggest — Search suggestions
  • search.highlight — Highlight search terms on page
features:
  - navigation.sections
  - navigation.top
  - content.code.copy

Plugin configuration

NeoAbs ships with an optional MkDocs plugin that sets theme defaults. See the Plugin documentation for details.

Adding custom CSS

Add custom stylesheets via extra_css:

extra_css:
  - stylesheets/custom.css

Place the file at docs/stylesheets/custom.css.

Override any design token:

:root {
  --neoabs-accent: #818cf8;
  --neoabs-canvas: #050510;
}

Adding custom JavaScript

Add custom scripts via extra_javascript:

extra_javascript:
  - javascripts/custom.js