EasyBar Documentation

Source for easybar.dev, the unified documentation site for EasyBar, EasyBar Native, EasyBarKit, Lua widgets, and the Widget Store.

Features

• Product installation, configuration, CLI, and troubleshooting guides
• Shared Lua widget guides and generated EasyBarKit API references
• Generated configuration reference from the EasyBarKit schema
• Generated Widget Store catalog from official package metadata and READMEs
• Contributor architecture and development documentation

Requirements

• Python 3.11 or newer
• Node.js with npx for formatting checks

Build locally

make build

The generated site is written to .site/. Serve it with live reload using:

make serve

Use sibling source checkouts while documenting uncommitted EasyBarKit or widget changes:

make build \
  SKIP_FETCH=1 \
  EASYBAR_KIT_ROOT=../easybar-kit \
  WIDGETS_ROOT=../widgets

Run the complete build and formatting checks with:

make check

Navigation

Navigation is generated from the content/ directory with mkdocs-awesome-nav. Keep the global MkDocs configuration focused on site behavior; use local .nav.yml files only when a section needs a custom title or order. Generated Widget Store package pages are discovered automatically, so new packages do not require edits to mkdocs.yml.

Use a meaningful index.md when a section needs a landing page. Do not add an index page only to make a directory appear in navigation.

Documentation

• Choose an EasyBar product
• Lua widgets
• Widget Store
• EasyBarKit platform
• Development

License

Licensed under the Apache License 2.0.