Skip to content

Commit

Permalink
docs: regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
abougouffa committed Jan 28, 2024
1 parent 6f1de1c commit f4211e3
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ make-readme-markdown.el:
combined.el:
cat init.el early-init.el core/me-{vars,lib,builtin,gc,compat,core-ui}.el modules/me-*.el modules/extras/me-*.el >combined.el

docs: combined.el make-readme-markdown.el
documentation: combined.el make-readme-markdown.el
emacs --script make-readme-markdown.el <combined.el >docs/DOCS.md 2>/dev/null

.INTERMEDIATE: make-readme-markdown.el combined.el
53 changes: 50 additions & 3 deletions docs/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,11 @@ Return whether BUFFER or the current buffer is binary.
A binary buffer is defined as containing at least one null byte.
Returns either nil, or the position of the first null byte.

#### `(+binary-file-p FILE &optional CHUNK)`

Is FILE a binary?
This checks the first CHUNK of bytes, defaults to 1024.

#### `(+binary-hexl-buffer-p &optional BUFFER)`

Does BUFFER (defaults to the current buffer) should be viewed using `hexl-mode`.
Expand Down Expand Up @@ -940,11 +945,11 @@ If FILENAME-FORMAT is non-nil, use it to as a format (ex. "file-%s.el").
Return the deserialized object, or nil if the SYM.el
file dont exist.

#### `(+scratch-buffer &optional DONT-RESTORE-P MODE DIRECTORY PROJECT-NAME)`
#### `(+scratch-buffer &optional DONT-RESTORE-P MODE DIRECTORY PROJ-NAME)`

Return a scratchpad buffer in major MODE.
When DONT-RESTORE-P, do not load the previously saved persistent buffer. Load
persistent buffer dedicated to PROJECT-NAME when provided.
persistent buffer dedicated to PROJ-NAME when provided.
When provided, set the `default-directory` to DIRECTORY.

#### `(+scratch-persist-buffer-h &rest _)`
Expand Down Expand Up @@ -994,7 +999,8 @@ If prefix ARG, delete all persistent scratches.

#### `(+scratch-replace-with-persistent-scratch &optional ARG PROJECT-P)`

Replace the *scratch* buffer with a .
Replace the *scratch* buffer with a persistent one.
ARG and PROJECT-P are passed to `+scratch-open-buffer`.

#### `(+font-installed-p FONT-FAMILY)`

Expand Down Expand Up @@ -1023,6 +1029,47 @@ is a pre-release.
This command stashes the current workspace before bumping the version, and
restores it after that.

#### `(+fold-from-eol &rest BODY)` (macro)

Execute BODY after moving to the end of the line.

#### `(+fold/toggle)`

Toggle the fold at point.
Targets `vimmish-fold`, `hideshow` and `outline` folds.

#### `(+fold/open)`

Open the folded region at point.
Targets `vimmish-fold`, `hideshow` and `outline` folds.

#### `(+fold/close)`

Close the folded region at point.
Targets `vimmish-fold`, `hideshow` and `outline` folds.

#### `(+fold/open-all &optional LEVEL)`

Open folds at LEVEL (or all folds if LEVEL is nil).

#### `(+fold/close-all &optional LEVEL)`

Close folds at LEVEL (or all folds if LEVEL is nil).

#### `(+fold/next COUNT)`

Jump to the next vimish fold, outline heading or folded region.

#### `(+fold/previous COUNT)`

Jump to the previous vimish fold, outline heading or folded region.

#### `(+fold-hideshow-indent-range &optional POINT)`

Return the point at the begin and end of the text block with the same (or greater) indentation.
If POINT is supplied and non-nil it will return the
begin and end of the block surrounding point.

#### `(eglot-ltex-workspace-config-fn &optional SERVER)`

A function to use as a value of `eglot-workspace-configuration`.
Expand Down

0 comments on commit f4211e3

Please sign in to comment.