https://github.com/hmu332233/kbd-txt

The "kbd-txt" is a lightweight (~850 B) library that formats keyboard shortcuts to work with Mac, Windows, and Linux operating systems, making it easier to display shortcuts for users on different systems.
https://github.com/hmu332233/kbd-txt

hacktoberfest kbd shortcut

Last synced: 4 days ago
JSON representation

The "kbd-txt" is a lightweight (~850 B) library that formats keyboard shortcuts to work with Mac, Windows, and Linux operating systems, making it easier to display shortcuts for users on different systems.

• Host: GitHub
• URL: https://github.com/hmu332233/kbd-txt
• Owner: hmu332233
• License: mit
• Created: 2022-09-05T15:33:59.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-08T13:31:49.000Z (about 1 year ago)
• Last Synced: 2024-09-17T00:35:50.946Z (about 2 months ago)
• Topics: hacktoberfest, kbd, shortcut
• Language: TypeScript
• Homepage: https://kbd-txt.minung.dev
• Size: 1.02 MB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kbd-txt

`kbd-txt` is a lightweight (~850 B) library that formats keyboard shortcuts to work with Mac, Windows, and Linux operating systems, making it easy to display shortcuts for users on different systems.

This library can be useful when you want to display keyboard shortcuts in a way that is specific to the user's operating system or for converting Mac keyboard shortcuts into symbols.

**[Demo »](https://kbd-txt.minung.dev)**  

**[Getting Started »](https://kbd-txt.minung.dev/docs/getting-started/introduction)**

## Packages

[pacakages/kbd-txt](https://github.com/hmu332233/kbd-txt/tree/feature/readme/packages/kbd-txt): Main Library  

[pacakages/docs](https://github.com/hmu332233/kbd-txt/tree/main/packages/kbd-txt): Docs using Docusaurus 2

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Minung Han
🚧 💻 📖

      
mononomo
⚠️

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## License

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