diff --git a/doc/modules/index.md b/doc/modules/index.md index 451cdde..9278a2d 100644 --- a/doc/modules/index.md +++ b/doc/modules/index.md @@ -47,7 +47,9 @@ Here's a real example. To use a module you simple have to require it. No new concepts. No magic. -## List of Modules +## Programming Language Modules + +The following programming languages have enhanced support in Prelude: - C/C++ - Clojure @@ -55,21 +57,36 @@ To use a module you simple have to require it. No new concepts. No magic. - Common Lisp - CSS - Emacs-Lisp -- [ERC](erc.md) - Erlang - Elixir - Go - Haskell - JavaScript - LaTeX -- Lisp Base +- Lisp Base (common foundation for Lisp modules) - Markdown +- OCaml - Org Mode - Perl - [Python](python.md) +- [Programming Base](programming.md) (common foundation for programming modules) - Ruby - Rust - Scala - Scheme - SCSS +- Shell +- TypeScript - Web +- XML +- YAML + +## Other Modules + +- company +- [ERC](erc.md) +- evil +- helm +- ido +- ivy +- key-chord diff --git a/doc/modules/programming.md b/doc/modules/programming.md new file mode 100644 index 0000000..7f8475d --- /dev/null +++ b/doc/modules/programming.md @@ -0,0 +1,15 @@ +# Prelude Programming + +Prelude's programming module enables some additional functionality +for `prog-mode` - the parent mode for all major programming modes in Emacs. + +Here are some features it provides: + +* spell-checking of comments (via `flyspell-prog-mode`) +* auto-pairing of delimiters like parentheses (via `smartparens`) +* visual ques for whitespace (via `whitespace-mode`) +* highlighting code annotations (via `hl-todo`) +* linter integration (via `flycheck`) +* showing current definition name in the modeline (via `which-func`) + +Most of this boils down to enabling a bunch of minor modes in `prog-mode-hook`. diff --git a/doc/modules/python.md b/doc/modules/python.md index 5657234..414f87d 100644 --- a/doc/modules/python.md +++ b/doc/modules/python.md @@ -1,9 +1,13 @@ # Prelude Python +!!! Note + + This module builds on top of the shared [Programming](programming.md) module. + ## Python Mode Emacs comes with Python programming support through the built-in -Python-mode. Whenever you are editing Python code run `C-h m` to +`python-mode`. Whenever you are editing Python code run `C-h m` to look at the Python mode key bindings. Alternatively look at the menu bar entries under Python. To toggle the menu bar press `F12`. diff --git a/mkdocs.yml b/mkdocs.yml index 4a57b66..c50cf36 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,6 +10,7 @@ pages: - Modules: - Overview: modules/index.md - ERC: modules/erc.md + - Programming: modules/programming.md - Python: modules/python.md - FAQ: faq.md - Troubleshooting: troubleshooting.md