Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uier/hackbar
A browser extension for using command palette (kbar) in HackMD.
https://github.com/uier/hackbar
chrome-extension command-palette firefox-addon hackmd kbar
Last synced: 1 day ago
JSON representation
A browser extension for using command palette (kbar) in HackMD.
- Host: GitHub
- URL: https://github.com/uier/hackbar
- Owner: uier
- License: mit
- Created: 2021-12-23T21:39:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-16T02:53:29.000Z (over 1 year ago)
- Last Synced: 2024-08-01T19:42:27.667Z (3 months ago)
- Topics: chrome-extension, command-palette, firefox-addon, hackmd, kbar
- Language: TypeScript
- Homepage: https://chrome.google.com/webstore/detail/hackbar/algbkiepdpcjnhgagoddfcicdeaiimba
- Size: 20.9 MB
- Stars: 36
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-command-palette - hackbar
README
[![Users][chrome-user-shield]][chrome-user-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Features](#features)
- [Built With](#built-with)
- [Installation](#installation)
- [Usage](#usage)
- [Basic](#basic)
- [Shortcuts](#shortcuts)
- [Development](#development)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## About The Project
hackbar provides a kbar component to use in HackMD.
### Features
- Create empty note or create from templates.
- Search & Open notes by title / tags / teams.
- Switch between workspaces (teams).
- Shortcuts for creating note and switching team.
### Built With
- [React.js](https://reactjs.org/)
- [kbar](https://kbar.vercel.app/)
- [lxieyang/chrome-extension-boilerplate-react](https://github.com/lxieyang/chrome-extension-boilerplate-react)
## Installation
- [Chrome extension (chrome web store)](https://chrome.google.com/webstore/detail/hackbar/algbkiepdpcjnhgagoddfcicdeaiimba)
- [Firefox add-on](https://addons.mozilla.org/firefox/addon/hackmd-kbar/)
- Manually download and locally load to your browser, see [Releases](https://github.com/uier/hackbar/releases).
## Usage
### Basic
- Press ⌘+k (Mac) / Ctrl+k (Windows & Linux) 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](https://hackmd.io/@uier/hackbar).
## Development
1. Clone the repo
```sh
git clone https://github.com/uier/hackbar.git
cd hackbar
```
2. Install dependencies
```sh
pnpm i
```
3. Build extension in `build/`
```sh
pnpm prepare
```
## Roadmap
- [ ] Search & Open notes in specific team (such as GitHub)
- [ ] Create note in specific team
See the [open issues](https://github.com/uier/hackbar/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 feat/amazing-feature`)
3. Commit your Changes with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
4. Push to the Branch (`git push origin feat/amazing-feature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
TzuWei Yu (uier) - [email protected]
Project Link: [https://github.com/uier/hackbar](https://github.com/uier/hackbar)
[chrome-user-shield]: https://img.shields.io/chrome-web-store/users/algbkiepdpcjnhgagoddfcicdeaiimba?style=for-the-badge
[chrome-user-url]: https://chrome.google.com/webstore/detail/hackbar/algbkiepdpcjnhgagoddfcicdeaiimba
[contributors-shield]: https://img.shields.io/github/contributors/uier/hackbar.svg?style=for-the-badge
[contributors-url]: https://github.com/uier/hackbar/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/uier/hackbar.svg?style=for-the-badge
[forks-url]: https://github.com/uier/hackbar/network/members
[stars-shield]: https://img.shields.io/github/stars/uier/hackbar.svg?style=for-the-badge
[stars-url]: https://github.com/uier/hackbar/stargazers
[issues-shield]: https://img.shields.io/github/issues/uier/hackbar.svg?style=for-the-badge
[issues-url]: https://github.com/uier/hackbar/issues
[license-shield]: https://img.shields.io/github/license/uier/hackbar.svg?style=for-the-badge
[license-url]: https://github.com/uier/hackbar/blob/master/LICENSE
