Installation¶

Get NeoAbs up and running in a few steps.

Requirements¶

• Python 3.9 or higher
• MkDocs 1.5 or higher
• A modern browser with support for backdrop-filter

Install¶

pip install mkdocs-neoabs

Create a project¶

mkdocs new my-docs
cd my-docs

Enable the theme¶

Replace the contents of mkdocs.yml:

site_name: My Docs
theme:
  name: neoabs

Serve¶

mkdocs serve

Open http://127.0.0.1:8000 in your browser. You should see the NeoAbs theme with glass panels, dot matrix background, and the default palette.

Verify installation¶

Run the following to confirm everything is in place:

mkdocs --version
pip show mkdocs-neoabs

Next steps¶

• Configuration -- customize the theme to your liking
• Design System -- learn how the design works under the hood