doomemacs/modules/lang/racket/README.org
Henrik Lissner 1255315bfc
refactor(docs): replace nav menus with virtual one
Now that the header is dynamically generated (when doom-docs-mode is
active), a literal header is unnecessary.
2022-08-02 19:37:07 +02:00

88 lines
2.6 KiB
Org Mode

#+title: :lang racket
#+subtitle: The DSL for DSLs
#+created: July 29, 2018
#+since: 2.0.9 (#772)
* Description :unfold:
This module adds support for the [[https://www.racket-lang.org/][Racket programming language]] to Doom Emacs.
** Maintainers
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags
- +lsp ::
Enable support for ~racket-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports [[https://github.com/jeapostrophe/racket-langserver][racket-langserver]]).
- +xp ::
Enable the explore mode (~racket-xp-mode~), which "analyzes expanded code to
explain and explore."
** Packages
- [[doom-package:][racket-mode]]
** Hacks
/No hacks documented for this module./
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
This module requires ~racket~. Install it from the [[https://download.racket-lang.org/][racket website]] or through
your OS package manger.
** Arch Linux
#+begin_src sh
pacman -S racket
#+end_src
Or, for fewer dependencies:
#+begin_src sh
pacman -S racket-minimal
#+end_src
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Configuration
#+begin_quote
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote
** racket-smart-open-bracket-mode
~racket-smart-open-bracket-mode~ gets turned off automatically if you use
~parinfer~, ~lispy~. If you wish to enable it:
#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(after! racket-mode
(add-hook 'racket-mode-hook #'racket-smart-open-bracket-mode))
#+end_src
** Unicode Input
The optional ~racket-unicode~ input method lets you type unicode characters such
as λ or π. To enable unicode input for a single buffer, run
~racket-unicode-input-method-enable~. To enable unicode input by default on all
racket buffers:
#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(add-hook 'racket-mode-hook #'racket-unicode-input-method-enable)
(add-hook 'racket-repl-mode-hook #'racket-unicode-input-method-enable)
#+end_src
Once enabled, unicode input can be toggled by pressing C-\ or running
~toggle-input-method~.
* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote