emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: add category readmes

Browse source
This commit is contained in:
Henrik Lissner 2021-10-12 01:56:49 +02:00 • committed by Henrik Lissner
parent 3231db863c
commit df62fcba26
11 changed files with 108 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
modules/README.md Normal file
View file

@ -0,0 +1,3 @@
# Modules
Check out Doom's module list at https://docs.doomemacs.org/modules.

12
modules/app/README.org Normal file
View file

@ -0,0 +1,12 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::app nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :app
#+SUBTITLE: The ultimate code completion backend
#+CREATED: February 19, 2017
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
Application modules are complex and opinionated modules that transform Emacs
toward a specific purpose. They may have additional dependencies and *should be
loaded last*, before =:config= modules.

9
modules/checkers/README.org Normal file
View file

@ -0,0 +1,9 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::checkers nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :checkers
#+CREATED: August 1, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
For modules dedicated to linting text.

10
modules/completion/README.org Normal file
View file

@ -0,0 +1,10 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::completion nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :completion
#+DATE: July 29, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
These modules provide interfaces and frameworks completion, including code
completion.

10
modules/config/README.org Normal file
View file

@ -0,0 +1,10 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::config nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :config
#+CREATED: July 29, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
Modules that configure Emacs one way or another, or focus on making it easier
for you to customize it yourself. It is best to load these last.

10
modules/editor/README.org Normal file
View file

@ -0,0 +1,10 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::editor nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :editor
#+CREATED: July 30, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
For modules concerned with the insertion, manipulation, and general editing of
text. Amen.

9
modules/emacs/README.org Normal file
View file

@ -0,0 +1,9 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::emacs nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :emacs
#+CREATED: August 1, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
Modules in this category augment and extend the built-in features of Emacs.

9
modules/lang/README.org Normal file
View file

@ -0,0 +1,9 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::lang nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :lang
#+CREATED: August 3, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
These modules specialize in adding language support to Emacs.

15
modules/term/README.org Normal file
View file

@ -0,0 +1,15 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::term nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :term
#+CREATED: August 1, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
What's an operating system without a terminal? The moduels in this category
bring varying degrees of terminal emulation into Emacs.
If you can't decide which to choose, I recommend [[doom-package:][vterm]] or [[doom-package:][eshell]]. [[doom-module:][:term vterm]]
offers that best terminal emulation available but requires a few extra steps to
get going. [[doom-module:][:term eshell]] works everywhere that Emacs runs, even Windows, and
provides a shell entirely implemented in Emacs Lisp.

10
modules/tools/README.org Normal file
View file

@ -0,0 +1,10 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::tools nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :tools
#+CREATED: July 29, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
Replace this with a description of what modules in this category are for,
including any important information (like load order constraints).

11
modules/ui/README.org Normal file
View file

@ -0,0 +1,11 @@
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::ui nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :ui
#+SUBTITLE: <A one-liner to display in init.example.el>
#+CREATED: July 29, 2021
#+SINCE: v21.12.0
#+SETUPFILE: ../../docs/.setupfile.org
* Description
For modules who specialize in changing Emacs' appearance or providing interfaces
for its features, like sidebars, tabs, or fonts.