Skip to content

feat: Expand the Emacs section #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
magnus-madsen merged 2 commits into from
Aug 13, 2026
+16 −1
Merged

feat: Expand the Emacs section #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39c1b34
Expand the Emacs section with plain Emacs and Spacemacs
lagenorhynque Aug 12, 2026
cb77154
Add Kent OHASHI
lagenorhynque Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ By adding your name to this document, you agree to release all your contribution
- [Stephen Bastians](https://github.com/stetimi)
- [Jonathan Lindegaard Starup](https://github.com/JonathanStarup)
- [Michał Kukieła](https://github.com/kukimik)
- [Kent OHASHI](https://github.com/lagenorhynque)
16 changes: 15 additions & 1 deletion src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,21 @@ LSP is not attached, and reports an error if no `flix.toml` is found.

## Using Flix from Emacs

Flix can be used from [Emacs](https://www.gnu.org/software/emacs/) as well by installing the [flix-mode](https://codeberg.org/mdiin/flix-mode) package. Follow the instructions there to get started writing Flix code in Emacs.
Flix can be used from [Emacs](https://www.gnu.org/software/emacs/), either in
plain Emacs or in [Spacemacs](https://www.spacemacs.org/). Both drive the Flix
compiler's LSP server for full language support.

### Plain Emacs

Install the [flix-mode](https://github.com/flix/emacs) package (the major
mode) and configure it with an LSP client (`eglot` or `lsp-mode`). Its README
has minimal, ready-to-use configurations for both.

### Spacemacs

Add the [flix layer](https://github.com/flix/spacemacs), which wires up
flix-mode with `lsp-mode` and the Spacemacs key-binding system. Its README has
installation and configuration instructions.

## Using Flix from the CLI

Expand Down
Loading