Skip to content

Commit

Permalink
docs: update modules documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@abougouffa
abougouffa committed Jul 13, 2023
1 parent 90defba commit 5828984
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 58 deletions.
2 changes: 1 addition & 1 deletion core/me-builtin.el
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;;; me-builtin.el --- Customization of some of Emacs' builtin libraries -*- lexical-binding: t; -*-
;;; me-builtin.el --- Emacs built-in packages -*- lexical-binding: t; -*-

;; Copyright (C) 2022-2023 Abdelhak Bougouffa

Expand Down
85 changes: 43 additions & 42 deletions core/me-modules.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,53 +7,54 @@
;;; Code:

(defcustom minemacs-core-modules
'(me-splash ; Simple splash screen
me-keybindings ; Keybinding (general, which-key, hydra, ...)
me-evil ; Emacs as Vim (evil, evil-collection, evil-escape, evil-snipe, evil-numbers, ...)
me-core-ui ; Core UI (doom-themes, modus-themes, doom-modeline, ...)
me-completion) ; Completion (vertico, marginalia, corfu, cape, consult, embark, ...)
'(me-splash
me-keybindings
me-evil
me-core-ui
me-completion)
"MinEmacs enabled core modules."
:group 'minemacs-core
:type '(repeat symbol))

(defcustom minemacs-modules
'(me-ui ; User interface (focus, writeroom-mode, mixed-pitch, ...)
me-editor ; Editing (yasnippet, smartparens, unicode-fonts, ligature, ...)
me-daemon ; Emacs daemon tweaks
me-undo ; Better undoing (undo-fu, undo-fu-session, vundo, ...)
me-multi-cursors ; Multi-cursors editing (iedit, evil-mc, evil-iedit-state, ...)
me-vc ; Version control (magit, forge, core-review, diff-hl, ...)
me-project ; Project management (project, projectile, consult-projectile, treemacs-projectile, ...)
me-prog ; Programming stuff (tree-sitter, eglot, eldoc, eldoc-box, apheleia, editorconfig, ...)
me-checkers ; Static checkers (flymake, flymake-easy, ...)
me-debug ; Debugging tools (gdb-mi, realgud, disaster, ...)
;; me-lsp ; LSP and DAP (lsp-mode, dap-mode, consult-lsp, lsp-pyright, ccls, ...)
me-lisp ; Lisps development (parinfer-rust, sly, macrostep, geiser, elisp, helpful, eros, ...)
;; me-embedded ; Embedded systems (arduino, openocd, bitbake, vhdl-mode, ...)
;; me-robot ; Robotics stuff (ros, robot-mode, ...)
me-data ; Data file formats (csv, yaml, toml, json, plantuml-mode, ...)
;; me-math ; Mathematics (maxima, ess, ein, julia-mode, octave, ...)
;; me-modeling ; Modeling tools (scad-mode, ...)
me-org ; Org-mode for life (org, org-contrib, org-modern, org-appear, ...)
me-extra ; Extra features (better-jumper, crux, ...)
me-notes ; Notes & Zettelkasten (org-roam, consult-org-roam, ...)
me-eaf ; EAF apps (browser, jupyter, file-sender, ...)
;; me-email ; Email (mu4e, mu4e-alert, org-msg, ...)
;; me-rss ; News feed (elfeed, ...)
;; me-lifestyle ; *Very* opinionated lifestyle packages (awqat, ...)
me-docs ; Documents (pdf-tools, nov, ...)
;; me-calendar ; Calendar (calfw, calfw-org, calfw-ical, ...)
me-latex ; LaTeX (auctex, auctex-latexmk, reftex, bibtex, ...)
;; me-biblio ; Bibliography & citations (org-cite, citar, zotxt, ...)
me-natural-langs ; Natural language stuff (spell-fu, go-translate, eglot-ltex, ...)
me-files ; Files and directories (dirvish, treemacs, vlf, ...)
me-tools ; System tools (tramp, vterm, tldr, ssh-deploy, docker, ...)
me-tty ; Emacs from terminal (xt-mouse, xclip, ...)
;; me-fun ; Games and funny packages (xkcd, speed-type, ...)
;; me-media ; Multimedia (empv, emms, ...)
;; me-workspaces ; Workspace separation (tabspaces, tab-bar, ...). NOTE: This is a WIP
me-binary ; Display binary files in hex or decompile them (hexl, ...) ...
me-window) ; Frame & window tweaks
'(me-ui
me-editor
me-daemon
me-undo
me-multi-cursors
me-vc
me-project
me-prog
me-checkers
;; me-assistants
me-debug
;; me-lsp
me-lisp
;; me-embedded
;; me-robot
me-data
;; me-math
;; me-modeling
me-org
me-extra
me-notes
me-eaf
;; me-email
;; me-rss
;; me-lifestyle
me-docs
;; me-calendar
me-latex
;; me-biblio
me-natural-langs
me-files
me-tools
me-tty
;; me-fun
;; me-media
;; me-workspaces
me-binary
me-window)
"MinEmacs enabled modules."
:group 'minemacs-core
:type '(repeat symbol))
Expand Down
29 changes: 14 additions & 15 deletions skel/modules.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,24 @@

;;; List of enabled modules
(setq minemacs-modules
'(me-ui ; User interface (focus, writeroom-mode, mixed-pitch, ...)
'(me-ui ; User interface (svg-lib, focus, mixed-pitch, ...)
me-editor ; Editing (tempel, smartparens, unicode-fonts, ligature, ...)
me-daemon ; Emacs daemon tweaks
me-undo ; Better undoing (undo-fu, undo-fu-session, vundo, ...)
me-multi-cursors ; Multi-cursors editing (iedit, evil-mc, evil-iedit-state, ...)
me-vc ; Version control (magit, forge, core-review, diff-hl, ...)
me-project ; Project management (project, consult-project-extra, ...)
me-prog ; Programming stuff (tree-sitter, eglot, eldoc, eldoc-box, apheleia, editorconfig, ...)
me-checkers ; Static checkers (flymake, flymake-easy, ...)
;; me-assistants ; AI based assistants (chatgpt, codepilot, ...)
me-debug ; Debugging tools (gdb-mi, realgud, disaster, ...)
me-project ; Project management (consult-project-extra, ibuffer-project, ...)
me-prog ; Programming stuff (tree-sitter, eldoc-box, apheleia, editorconfig, ...)
me-checkers ; Static checkers (flymake-easy, ...)
me-debug ; Debugging tools (realgud, disaster, ...)
;; me-lsp ; LSP and DAP (lsp-mode, dap-mode, consult-lsp, lsp-pyright, ccls, ...)
me-lisp ; Lisps development (parinfer-rust, sly, macrostep, geiser, elisp, helpful, eros, ...)
;; me-embedded ; Embedded systems (arduino, openocd, bitbake, vhdl-mode, ...)
me-lisp ; Lisps development (parinfer-rust, sly, macrostep, geiser, helpful, eros, ...)
;; me-embedded ; Embedded systems (arduino, openocd, bitbake, ...)
;; me-robot ; Robotics stuff (ros, robot-mode, ...)
me-data ; Data file formats (csv, yaml, toml, json, plantuml-mode, ...)
;; me-math ; Mathematics (maxima, ess, ein, julia-mode, octave, ...)
;; me-math ; Mathematics (maxima, ess, ein, julia-mode, ...)
;; me-modeling ; Modeling tools (scad-mode, ...)
me-org ; Org-mode for life (org, org-contrib, org-modern, org-appear, ...)
me-org ; Org-mode for life (org-contrib, org-modern, org-appear, ...)
me-extra ; Extra features (better-jumper, crux, ...)
me-notes ; Notes & Zettelkasten (org-roam, consult-org-roam, ...)
me-eaf ; EAF apps (browser, jupyter, file-sender, ...)
Expand All @@ -42,16 +41,16 @@
;; me-lifestyle ; *Very* opinionated lifestyle packages (awqat, ...)
me-docs ; Documents (pdf-tools, nov, ...)
;; me-calendar ; Calendar (calfw, calfw-org, calfw-ical, ...)
me-latex ; LaTeX (auctex, auctex-latexmk, reftex, bibtex, ...)
;; me-biblio ; Bibliography & citations (org-cite, citar, zotxt, ...)
me-latex ; LaTeX (auctex, auctex-latexmk, ...)
;; me-biblio ; Bibliography & citations (citar, zotxt, ...)
me-natural-langs ; Natural language stuff (spell-fu, go-translate, eglot-ltex, ...)
me-files ; Files and directories (dirvish, treemacs, vlf, ...)
me-tools ; System tools (tramp, vterm, tldr, ssh-deploy, docker, ...)
me-tools ; System tools (vterm, tldr, ssh-deploy, docker, ...)
me-tty ; Emacs from terminal (xt-mouse, xclip, ...)
me-fun ; Games and funny packages (xkcd, speed-type, ...)
me-media ; Multimedia (empv, emms, ...)
;; me-workspaces ; Workspace separation (tabspaces, tab-bar, ...)
me-binary ; Display binary files in hex or decompile them (hexl, ...) ...
;; me-workspaces ; Workspace separation (tabspaces, ...)
me-binary ; Display binary files in hex or decompile them
me-window)) ; Frame & window tweaks

;;; List of disabled packages
Expand Down

0 comments on commit 5828984

Please sign in to comment.