diff --git a/modules/README.md b/modules/README.md new file mode 100644 index 000000000..4fac8c596 --- /dev/null +++ b/modules/README.md @@ -0,0 +1,3 @@ +# Modules + +Check out Doom's module list at https://docs.doomemacs.org/modules. diff --git a/modules/app/README.org b/modules/app/README.org new file mode 100644 index 000000000..62d4644af --- /dev/null +++ b/modules/app/README.org @@ -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. diff --git a/modules/checkers/README.org b/modules/checkers/README.org new file mode 100644 index 000000000..ccc1a5fb0 --- /dev/null +++ b/modules/checkers/README.org @@ -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. diff --git a/modules/completion/README.org b/modules/completion/README.org new file mode 100644 index 000000000..bd693bf38 --- /dev/null +++ b/modules/completion/README.org @@ -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. diff --git a/modules/config/README.org b/modules/config/README.org new file mode 100644 index 000000000..a281f7866 --- /dev/null +++ b/modules/config/README.org @@ -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. diff --git a/modules/editor/README.org b/modules/editor/README.org new file mode 100644 index 000000000..95fd22023 --- /dev/null +++ b/modules/editor/README.org @@ -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. diff --git a/modules/emacs/README.org b/modules/emacs/README.org new file mode 100644 index 000000000..7401eb913 --- /dev/null +++ b/modules/emacs/README.org @@ -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. diff --git a/modules/lang/README.org b/modules/lang/README.org new file mode 100644 index 000000000..adedce410 --- /dev/null +++ b/modules/lang/README.org @@ -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. diff --git a/modules/term/README.org b/modules/term/README.org new file mode 100644 index 000000000..18b4dd825 --- /dev/null +++ b/modules/term/README.org @@ -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. diff --git a/modules/tools/README.org b/modules/tools/README.org new file mode 100644 index 000000000..d3d0b970b --- /dev/null +++ b/modules/tools/README.org @@ -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). diff --git a/modules/ui/README.org b/modules/ui/README.org new file mode 100644 index 000000000..7d21675f1 --- /dev/null +++ b/modules/ui/README.org @@ -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: +#+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.