Awesome
<div id="top"></div> <br /> <div align="center"> <a href="https://github.com/uier/hackbar"> <img src="src/assets/img/icon-128.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">hackbar</h3> <p align="center"> A browser extension for using kbar in HackMD <br /> <a href="https://github.com/uier/hackbar/issues">Report Bug / Request Feature</a> </p> </div> <div align="center"> <a href="https://chrome.google.com/webstore/detail/hackbar/algbkiepdpcjnhgagoddfcicdeaiimba" target="_blank" rel="noreferrer noopenner"> <img src="https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png" /> </a> <a href="https://addons.mozilla.org/firefox/addon/hackmd-kbar" target="_blank" rel="noreferrer noopenner"> <img src="https://blog.mozilla.org/addons/files/2015/11/get-the-addon.png" /> </a> </div>Table of Contents
- Table of Contents
- About The Project
- Installation
- Usage
- Development
- Roadmap
- Contributing
- License
- 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
<p align="right">(<a href="#top">back to top</a>)</p>Installation
- Chrome extension (chrome web store)
- Firefox add-on
- Manually download and locally load to your browser, see Releases.
Usage
Basic
- Press <kbd>⌘</kbd>+<kbd>k</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>k</kbd> (Windows & Linux) to open kbar.
- Directly search things. Open note by title/tag, create note from template, team name.
Shortcuts
- Press <kbd>+</kbd> to navigate to note creating view.
- Press <kbd>@</kbd> to navigate to team switching view.
- Shortcuts also work when kbar is closed.
For more detail, please refer to the Documentation on HackMD.
<p align="right">(<a href="#top">back to top</a>)</p>Development
- Clone the repo
git clone https://github.com/uier/hackbar.git cd hackbar
- Install dependencies
pnpm i
- Build extension in
build/
pnpm prepare
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).
<p align="right">(<a href="#top">back to top</a>)</p>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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/amazing-feature
) - Commit your Changes with Conventional Commits
- Push to the Branch (
git push origin feat/amazing-feature
) - 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
<p align="right">(<a href="#top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->