A browser extension for using kbar in HackMD

hackbar

A browser extension for using kbar in HackMD Report Bug · Request Feature

About The Project

hackbar provides a kbar component to use in HackMD.

Features:

  • Search notes, teams, tags, templates.
  • Create empty note or from templates.
  • Switch between workspaces (teams).
  • Open recent or searched notes directly.
  • Shortcuts for creating note and switching team.

Built With

Usage

Basic

  • Press +k / Ctrl+k to open kbar.
  • Directly search things. Open note by title/tag, create note from template, team name.

Shortcuts

  • Press + to navigate to note creating view.
  • Press @ to navigate to team switching view.
  • Shortcuts also work when kbar is closed.

For more detail, please refer to the Documentation on HackMD.

Getting Started

Installation

Development

  1. Clone the repo

    git clone https://github.com/Uier/hackbar.git
    cd hackbar
  2. Run dev server
    yarn start
  3. Build production
    yarn build

Roadmap

  • Search & Open notes in specific team (such as GitHub)
  • Create note in specific team

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

TzuWei Yu (Uier) – ap9940506@gmail.com

Project Link: https://github.com/Uier/hackbar

GitHub

View Github