Skip to content

badgeify/badgeify-docs

Repository files navigation

Badgeify Documentation

This repository contains the official documentation for Badgeify, a macOS menu bar app that transforms your Mac's menu bar into a powerful notification and app launching hub.

About Badgeify

Badgeify is your ultimate menu bar companion for macOS that helps you:

  • Stay updated with notifications from all your apps
  • Launch applications quickly
  • Keep your workspace clean and organized

Documentation Structure

The documentation is organized as follows:

  • Get Started

    • introduction.mdx - Overview of Badgeify
    • quickstart.mdx - Installation and setup guide
  • Features

    • customize-icon.mdx - How to customize application icons
    • icon-visibility.mdx - Managing icon visibility
    • highlight-color.mdx - Customizing notification highlight colors
    • app-groups.mdx - Creating and managing app groups
  • Troubleshooting

    • Various guides to solve common issues

Development

This documentation is built with Mintlify, as specified in the docs.json configuration file.

Local Development

To run the documentation locally:

  1. Install Mintlify CLI: npm install -g mintlify
  2. Run the development server: mintlify dev
  3. Visit http://localhost:3000 to preview the documentation

Deployment

The documentation is automatically deployed through Mintlify's platform when changes are pushed to the main branch.

External Links

License

Please refer to the project license for usage terms and conditions.

About

The official documentation for Badgeify

Resources

Stars

Watchers

Forks

Contributors

Generated from mintlify/starter