Commit graph

22 commits

Author SHA1 Message Date
Henrik Lissner
6f40ad55f5
docs: discourage after! and use-package! use
There's little reason for users to use these macros in their private
configs over plain ol' `with-eval-after-load` and `use-package`, unless
they're writing their own modules.

It's my fault for signal boosting them in documentation and whenever I'm
asked for help, because beginners now believe they are somehow
required for Doom to work correctly (there are guides out there
telling beginners that migrating to Doom involves replacing all
instances of `with-eval-after-load` and `use-package` in their
pre-existing configs with `after!` and `use-package!` -- which was never
true).

What's more, I plan to replace `use-package`, internally, so the
`use-package!` macro won't exist for much longer.
2026-02-09 04:29:47 -05:00
Henrik Lissner
88bb045388
docs(*): replace all-the-icons with nerd-icons
Also colorizes the leading icon in notices.
2023-09-16 20:19:11 +02:00
TEC
5ac2a5258b docs: change link format 2022-10-05 01:01:19 +02:00
Henrik Lissner
1abcf913aa
revert: fix(docs): set mode in file-local vars
emacs-straight/org-mode@e22b4eb7aa introduced a breaking change that
made it impossible to rely on .dir-locals.el to change org-mode buffers
in $EMACSDIR to doom-docs-org-mode (without infinite recursion), so we
used file-local variables in 7e400ab.

emacs-straight/org-mode@215de6176b reverted that change, so we can use
.dir-locals.el again, and this is my preference, since it requires less
boilerplate across our hundreds of org files.

Ref: emacs-straight/org-mode@215de6176b
Ref: emacs-straight/org-mode@e22b4eb7aa
Revert: 7e400abdc0
2022-08-07 19:08:07 +02:00
Henrik Lissner
7e400abdc0
fix(docs): set mode in file-local vars
Due to emacs-straight/org-mode@e22b4eb, a replacement major mode (for
org-mode) can no longer be specified from .dir-locals.el, as it spirals
into infinite recursion. Therefore, a mode: line is needed in all Doom
docs.

Ref: emacs-straight/org-mode@e22b4eb7aa
2022-08-03 02:46:33 +02:00
Henrik Lissner
1255315bfc
refactor(docs): replace nav menus with virtual one
Now that the header is dynamically generated (when doom-docs-mode is
active), a literal header is unnecessary.
2022-08-02 19:37:07 +02:00
Henrik Lissner
e77a45bc22
docs: use lowercase keywords
As per Org's new defaults, which we're adopting elsewhere, so may as
well adopt it here.
2022-08-02 16:23:43 +02:00
Henrik Lissner
7246db457c docs: replace doom-source with doom-repo links
I will later use "source" to refer to module sources, so better we avoid
the terminology for now.
2022-02-01 18:55:27 +01:00
Zero King
7423eef243 docs(lookup): fix typos 2022-01-03 18:05:56 +01:00
Henrik Lissner
88844e9cec docs: simplify internal docs links
Fewer links means less confusion.

- Merge doom-issue and doom-commit links into doom-ref (for auto-linking
  Issue/PR/commit references).
- Merge doom-module-source and doom-docs-source links into doom-source.
- Rename doom-report-issue to doom-report.
- Use '!' as the icon for module issues link.
- Remove doom-repo (replaced with "doom:*" in :lang org module).
- Add doomdir and emacsdir links to :lang org module.
2021-11-21 20:04:28 +01:00
Henrik Lissner
6da20e45bd docs(:tools): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
5ee8080ca7 Respect dash-docs-browser-func
Formerly, `+lookup/in-docsets` would disregard
dash-docs-browser-func (locally setting it to the value of
`+lookup-open-url-fn`). Now only `+lookup/online` respects
+lookup-open-url-fn and `+lookup/in-docsets` respects
`dash-docs-brwoser-func`.

Closes #4795
2021-04-14 23:31:13 -04:00
Henrik Lissner
ec225ac4b5 tools/lookup: remove mention of +lookup/install-docset
It was removed some time ago (replaced upstream by
dash-docset-install-docset).
2021-03-12 22:58:15 -05:00
Seong Yong-ju
9caf05ffe4 Update :tools/lookup +xwidget support
Remove :tools/lookup +xwidget. Provide
`+lookup-xwidget-webkit-open-url-fn` so that we can manually configure
Xwidget WebKit browser for `+lookup/online` or `+lookup/in-docsets`.
2020-06-24 12:37:56 +09:00
Rohit Goswami
e08b0d600e
lookup: Update docs 2020-05-10 23:47:44 +00:00
Seong Yong-ju
174ab0303f Add Dash docsets + Xwidget integration 2020-05-07 01:05:57 +09:00
Henrik Lissner
30dea4bf0c
Update tools/lookup readme
Relevant to #1166
2020-04-25 02:55:06 -04:00
Henrik Lissner
038e52d709
tools/lookup: add +offline feature
For offline dictionary/thesaurus lookup, using wordnut and synosaurus.
2020-01-25 19:02:01 -05:00
Niklas Carlsson
3308fb3718 Minor updates to documentation
- Update the keybinding for +doom/help-autodefs
- Remove silver_search from the lookup module. Ripgrep is the supported
dependency.
2020-01-13 09:54:22 +01:00
Henrik Lissner
7742813a06
tools/lookup: add +dictionary feature
For looking up words in dictionaries and thesauruses. Requires internet
connection (for now).
2019-12-20 00:59:51 -05:00
Henrik Lissner
d481fc1dd4
tools/lookup: update README & docstrings
And minor reformatting of config.el
2019-05-03 20:44:49 -04:00
Henrik Lissner
77e4cc4d58
💥 Remove :feature category
:feature was a "catch-all" category. Many of its modules fit better in
other categories, so they've been moved:

- feature/debugger -> tools/debugger
- feature/evil -> editor/evil
- feature/eval -> tools/eval
- feature/lookup -> tools/lookup
- feature/snippets -> editor/snippets
- feature/file-templates -> editor/file-templates
- feature/workspaces -> ui/workspaces

More potential changes in the future:

- A new :term category for terminal emulation modules (eshell, term and
  vterm).
- A new :os category for modules dedicated to os-specific functionality.
  The :tools macos module would fit here, but so would modules for nixos
  and arch.
- A new :services category for web-service integration, like wakatime,
  twitter, elfeed, gist and pastebin services.
2019-04-24 18:16:04 -04:00
Renamed from modules/feature/lookup/README.org (Browse further)