https://github.com/keyweeusr/dbml-mode
Major mode for DBML (dbdiagram.io)
https://github.com/keyweeusr/dbml-mode
database dbml dbml-editor diagram emacs emacs-mode emacs-package
Last synced: about 1 year ago
JSON representation
Major mode for DBML (dbdiagram.io)
- Host: GitHub
- URL: https://github.com/keyweeusr/dbml-mode
- Owner: KeyWeeUsr
- License: gpl-3.0
- Created: 2024-09-12T05:38:00.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-06T07:06:28.000Z (over 1 year ago)
- Last Synced: 2025-03-28T22:32:06.525Z (over 1 year ago)
- Topics: database, dbml, dbml-editor, diagram, emacs, emacs-mode, emacs-package
- Language: Emacs Lisp
- Homepage:
- Size: 165 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# dbml-mode
[![MELPA][melpa-badge]][melpa-package]
[![MELPA Stable][melpa-stable-badge]][melpa-stable-package]
[![CI][ci-badge]][ci-workflow]
[![Coverage Status][cover-badge]][cover-link]
[![Buy me a coffee][bmc-badge]][bmc-link]
[![Liberapay][lp-badge]][lp-link]
[![PayPal][ppl-badge]][ppl-link]
This major mode attempts to port all of the syntax highlighting from
https://dbdiagram.io and build upon it by providing helpers such as duplicate
checking and rendering SVGs directly in Emacs.
![sample][gif]
## How to
Install it from [Melpa](https://melpa.org/#/getting-started) or clone and
install manually, then simply `M-x dbml-mode`.
### Enable for file extensions
It might be useful to auto-enable the mode for certain files or patterns. One
of such methods is updating `auto-mode-alist`:
```emacs-lisp
(add-to-list 'auto-mode-alist
'("\\.dbml\\'" . dbml-mode))
```
For every file with `.dbml` extension.
[melpa-badge]: http://melpa.org/packages/dbml-mode-badge.svg
[melpa-package]: http://melpa.org/#/dbml-mode
[melpa-stable-badge]: http://stable.melpa.org/packages/dbml-mode-badge.svg
[melpa-stable-package]: http://stable.melpa.org/#/dbml-mode
[bmc-badge]: https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee
[bmc-link]: https://www.buymeacoffee.com/peterbadida
[ppl-badge]: https://img.shields.io/badge/-paypal-grey?logo=paypal
[ppl-link]: https://paypal.me/peterbadida
[lp-badge]: https://img.shields.io/badge/-liberapay-grey?logo=liberapay
[lp-link]: https://liberapay.com/keyweeusr
[gif]: https://i.imgur.com/OpXUUVk.gif
[ci-badge]: https://github.com/KeyWeeUsr/dbml-mode/actions/workflows/test.yml/badge.svg
[ci-workflow]: https://github.com/KeyWeeUsr/dbml-mode/actions/workflows/test.yml
[cover-badge]: https://coveralls.io/repos/github/KeyWeeUsr/dbml-mode/badge.svg?branch=master
[cover-link]: https://coveralls.io/github/KeyWeeUsr/dbml-mode?branch=master