Skip to content

Commit

Permalink
docs: update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
abougouffa committed Nov 18, 2024
1 parent 5af36df commit 580731e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 44 deletions.
54 changes: 12 additions & 42 deletions docs/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,9 +489,19 @@ function.

Unbind setq hooks on HOOKS for VARS.

#### `(+compile-functions &rest FNS)`
#### `(+ignore-root &rest ROOTS)`

Add ROOTS to ignored projects, recentf, etc.

#### `(+package-disabled-p PACKAGE &optional MODULE)`

Queue FNS to be byte/natively-compiled after a brief delay.
Is package PACKAGE disabled in `minemacs-disabled-packages`.
Optionally, check also for the containing MODULE.

#### `(minemacs-modules &optional INCLUDE-ON-DEMAND INCLUDE-OBSOLETE)`

List all the available modules.
With optional INCLUDE-ON-DEMAND and INCLUDE-OBSOLETE.

#### `(+shell-command-to-string-ignore-stderr COMMAND)`

Expand All @@ -510,20 +520,6 @@ Load environment variables from shell and save them to `+env-file`.

Load environment variables from `+env-file`.

#### `(+ignore-root &rest ROOTS)`

Add ROOTS to ignored projects, recentf, etc.

#### `(+package-disabled-p PACKAGE &optional MODULE)`

Is package PACKAGE disabled in `minemacs-disabled-packages`.
Optionally, check also for the containing MODULE.

#### `(minemacs-modules &optional INCLUDE-ON-DEMAND INCLUDE-OBSOLETE)`

List all the available modules.
With optional INCLUDE-ON-DEMAND and INCLUDE-OBSOLETE.

#### `(+file-read-to-string FILENAME)`

Return a string with the contents of FILENAME.
Expand Down Expand Up @@ -789,22 +785,6 @@ RECURSIVE is non-nil.

Delete FILENAME and its associated visiting buffer.

#### `(+tramp-sudo-file-path FILE)`

Construct a Tramp sudo path to FILE. Works for both local and remote files.

#### `(+sudo-find-file FILE)`

Open FILE as root.

#### `(+sudo-this-file)`

Open the current file as root.

#### `(+sudo-save-buffer)`

Save this buffer as root. Save as new file name if called with prefix.

#### `(+copy-this-file-name)`

Save (copy) the file name of this buffer to the kill ring.
Expand Down Expand Up @@ -1082,16 +1062,6 @@ Extract the descriptions of MinEmacs packages.

Show the list of declared external dependencies.

#### `(+spellcheck-correct)`

Correct word at point.

#### `(+spellcheck-mode &optional ARG)`

Spell checking mode, with ARG.
Based on `jinx-mode` if available, `spell-fu-mode` and falls back
to built-in `flyspell-mode`.

#### `(+clang-format-get-style)`

Get the "-style" argument for clang-format.
Expand Down
4 changes: 2 additions & 2 deletions docs/PACKAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@

## `me-natural-langs`
* `jinx`: Just-in-time spell checker based on the Enchanted library
* `flyspell-correct`: Distraction-free words correction with `flyspell` via `completing-read`
* `lexic`: Fancy Emacs integration with the console version of StarDict
* `reverso`: Emacs client for www.reverso.net for translation, grammar check, context and synonyms search
* `me-eglot-ltex`: Internal package to add support for LTeX-LS specific commands to `eglot`
Expand Down Expand Up @@ -165,7 +166,7 @@
* `treesitter-context`: A `treesit`-based package to show code context, dim surrouding text, and fold code
* `eglot-x`: Extra non-standard functionalities for Eglot
* `gambol`: Emacs text actions using LSP symbol information
* `combobulate`: Structured editing and navigation in Emacs with Tree-Sitter
* `combobulate-setup`: Structured editing and navigation in Emacs with Tree-Sitter
* `consult-eglot`: Consult integration with Eglot
* `reformatter`: Define commands which run reformatters on the current Emacs buffer
* `apheleia`: Run code formatter on buffer contents without moving point
Expand Down Expand Up @@ -242,7 +243,6 @@
* `ssh-deploy`: github.com/cjohansson/emacs-ssh-deploy#deployment-configuration-examples
* `incus-tramp`: TRAMP integration for Incus containers
* `app-launcher`: Launch system applications from Emacs
* `emamux`: Manipulate "tmux" from Emacs
* `emacs-everywhere`: System-wide popup Emacs windows for quick edits
* `tldr`: Browse "tldr" pages from Emacs
* `vterm`: Fully-fledged terminal emulator inside Emacs based on "libvterm"
Expand Down

0 comments on commit 580731e

Please sign in to comment.