merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
@ -1,22 +1,11 @@
|
|||
#+TITLE: lang/common-lisp
|
||||
#+DATE: June 13, 2018
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :lang common-lisp
|
||||
#+subtitle: If you've seen one lisp, you've seen them all
|
||||
#+created: June 13, 2018
|
||||
#+since: 21.12.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#sly][Sly]]
|
||||
- [[#org-mode][org-mode]]
|
||||
- [[#configuration][Configuration]]
|
||||
|
||||
* Description
|
||||
|
||||
This module provides support for [[https://lisp-lang.org/][Common Lisp]] and the [[https://github.com/joaotavora/sly][Sly]] development
|
||||
* Description :unfold:
|
||||
This module provides support for [[https://lisp-lang.org/][Common Lisp]] and the [[doom-package:][Sly]] development
|
||||
environment. Common Lisp is not a single language but a specification, with many
|
||||
competing compiler implementations. By default, [[http://www.sbcl.org/][Steel Bank Common Lisp]] (SBCL) is
|
||||
assumed to be installed, but this can be configured.
|
||||
|
@ -27,45 +16,65 @@ style often unseen in other languages. Compiled Common Lisp programs are trusted
|
|||
to run unmodified for a long time.
|
||||
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
This module has no dedicated maintainers.
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Module Flags
|
||||
** Packages
|
||||
- [[doom-package:][sly]]
|
||||
- [[doom-package:][sly-macrostep]]
|
||||
- [[doom-package:][sly-repl-ansi-color]]
|
||||
|
||||
This module provides no flags.
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
** Plugins
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
+ [[https://github.com/joaotavora/sly][sly]]
|
||||
+ [[https://github.com/joaotavora/sly-macrostep][sly-macrostep]]
|
||||
+ [[https://github.com/PuercoPop/sly-repl-ansi-color][sly-repl-ansi-color]]
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
* Prerequisites
|
||||
This module requires [[http://www.sbcl.org/][SBCL]].
|
||||
|
||||
This module requires the [[http://www.sbcl.org/][SBCL]] compiler to be installed.
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Features
|
||||
|
||||
This module does not integrate with the =lsp= module. Sly (and SLIME before it) is
|
||||
This module does not integrate with [[doom-module:][:tools lsp]]. Sly (and SLIME before it) is
|
||||
considered the defacto development environment for Common Lisp and provides much
|
||||
of what is normally expected of an LSP, plus tight integration with the REPL and
|
||||
Emacs.
|
||||
|
||||
** Sly
|
||||
|
||||
Using this module is mostly a matter of using Sly. Please consider reading
|
||||
through [[http://joaotavora.github.io/sly/#A-SLY-tour-for-SLIME-users][the Sly Tour]].
|
||||
|
||||
A Sly session will be started when you open a =.lisp= file. Use =SPC m '= to switch
|
||||
to the REPL minibuffer.
|
||||
A Sly session will be started when you open a =.lisp= file. Use [[kbd:][<localleader> ']]
|
||||
to switch to the REPL minibuffer.
|
||||
|
||||
** org-mode
|
||||
|
||||
This module also enables the evaluation of =lisp= source blocks in Org Mode.
|
||||
However, you will need a running Sly session for this to work. =M-x sly= starts
|
||||
However, you will need a running Sly session for this to work. ~M-x sly~ starts
|
||||
such a session if you didn't have one open already.
|
||||
|
||||
* Configuration
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
If you don't want Sly to use SBCL, you can configure the variable
|
||||
~inferior-lisp-program~ to some other binary on your PATH.
|
||||
|
||||
* 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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue