Commit Graph

16844 Commits

Author SHA1 Message Date
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
893434a5db tweak(docs): org-display-remote-inline-images = 'cache
In doom-docs-org-mode buffers.
2022-08-03 02:46:32 +02:00
64496a6c66 refactor(docs): tidy up 2022-08-03 02:46:32 +02:00
acf7a8a48d feat(docs): add org-glossary support 2022-08-02 21:37:15 +02:00
6e06bbb062 fix(docs): remove redundant doom-docs-dir
A vestigial snippet for local testing accidentally left behind.
2022-08-02 21:34:39 +02:00
4a71d217bd nit(php): license => licence 2022-08-02 21:23:40 +02:00
6fde2f634c fix(docs): update to reflect upstream changes
Done to reflect the following changes in master and upstream:

- The fn!/lambda! swap in 23feb48.
- hlissner/doom-emacs moving to doomemacs/doomemacs.

Ref: 23feb482e9
2022-08-02 19:42:16 +02:00
a634eb5497 refactor(docs): remove kbd expansion & table realignment
Table realignment added 5-6s to doom-docs-mode's init time. And it is no
longer necessary without kbd expansion unaligning tables (e.g.
transforming "<leader>" to "SPC").
2022-08-02 19:39:44 +02:00
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
c34168fb2a docs(lsp): flesh out lsp-mode vs eglot comparison 2022-08-02 19:35:54 +02:00
24fab1242a docs(rest): mention +jq flag 2022-08-02 19:35:54 +02:00
514400215f refactor(docs): s/doom--docs-/doom-docs--/ 2022-08-02 19:35:54 +02:00
4ec0ea963e fix(docs): use org-fold-core-region
org-flag-region was replaced upstream with org-fold.
2022-08-02 19:35:54 +02:00
cf2024b356 tweak(docs): org-footnote-section = nil
In doom-docs-org-mode, so footnotes will always be placed at the end of
the current tree.
2022-08-02 16:24:36 +02:00
3deba740d3 feat(docs): add face:X link type to docs
For linking face symbols to documentation.
2022-08-02 16:24:36 +02:00
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
9744946a66 docs(ligatures): mention doom-unicode-font incompatibilities 2022-08-02 16:23:42 +02:00
cee641ddc8 feat(docs): hide leading stars 2022-08-02 16:23:42 +02:00
6bba5f8c03 tweak(docs): disable save-place when in documentation
Jumping to a saved position is more jarring than useful in
documentation. Especially for beginners.
2022-08-02 16:23:42 +02:00
4661ea89f2 tweak(docs): move point to first heading on visit 2022-08-02 16:23:42 +02:00
c4b7071397 fix(docs): don't hide src blocks indiscriminately 2022-08-02 16:23:42 +02:00
bfa90e82e9 refactor(docs): use org-with-wide-buffer
It uses save-excursion internally and is a little safer (in case of
narrowing).
2022-08-02 16:23:38 +02:00
839970c2de docs(mu4e): fix incorrect variable name in snippet
The variable name for toggling org-msg by default was changed in commit
6118ad5c12, leading to the provided
snippet not actually disabling org-msg.
2022-06-28 00:04:49 +02:00
fd6056bc23 docs(org): add reference to evil-org keybindings 2022-06-21 20:27:26 +02:00
3ac5d6d51a docs(spell): can't add word to personal dict
Adding `Cannot add [word] to any active dictionary` error to the
troubleshooting section.

I have had this problem multiple times now when I break my emacs and
wipe the `~/.config/emacs` directory and I can never remember what file
to create to get my spell check working properly.

Even though this is a bug and might be fixed in the future, I feel like
having it documented can be helpful in the short term and in the future.

Ref: #6246
2022-06-21 18:30:20 +02:00
cf0696f54b docs(fold): mention ts-fold package 2022-06-18 00:16:31 +02:00
969c6ae8aa docs(tree-sitter): document +tree-sitter flag in :lang readmes
Co-authored-by: Jeetaditya Chatterjee <jeetelongname@gmail.com>
2022-06-18 00:16:31 +02:00
b21de24311 docs(latex): add texlive-latexextra dependency for pdflatex exports
Exporting an org file to pdf via LaTeX (org-export-dispatch or 'SPC m
e', then 'l p') requires texlive-latexextra (Arch package name) to be
installed on the system.

For reference, the error raised when texlive-latexextra was missing was
that the file 'wrapfig.sty' was not found. The specific error likely
depends on the contents of the exported file. Internet searches reveal
that pdflatex may also complain about 'utf8x.def' being missing; this
file is also provided by texlive-latexextra.
2022-04-12 02:36:35 +02:00
8d8ec41c5c docs(agda): document +local flag 2022-04-12 02:31:50 +02:00
6fcb99b35a docs(company): code completion with multiple keywords 2022-03-19 16:38:27 +01:00
1daecbe59c fix(lib): cache errors in doom-docs-mode 2022-02-01 18:55:27 +01:00
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
1fb67e3cf7 docs(org): remove org-pretty-table
Package was removed in hlissner/doom-emacs@db7696b661.

Ref: hlissner/doom-emacs#6033
2022-02-01 18:55:27 +01:00
97ac670881 docs(snippets): document how to write your own snippets 2022-01-30 02:42:13 +01:00
402e5eb723 docs(modeline): mention modeline hiding & strange icons
Ref: #1166
2022-01-29 20:09:50 +01:00
0451c9b0bc docs(lsp): link to LSP tuning guide 2022-01-29 20:08:17 +01:00
8fa1f4bb6b docs(mu4e): enable automatic email fetching 2022-01-27 18:42:19 +01:00
4bdcf48a0b docs(org): add org-pretty-table to readme
Ref: #6033
Amend: 53ea2e4ce2
2022-01-27 16:30:47 +01:00
71535d7ffc docs(julia): update lsp environment to recent LTS
As of 1 Dec, Julia v1.6 is the new LTS release.

Ref: #6010
2022-01-27 03:37:26 +01:00
58192633aa docs(vterm): update nixos install instructions
Some time late 2019 emacsPackagesNgGen was removed from NixOS. This
commit updates the instructions in the vterm readme to use the modern
alternative: emacsPackagesFor.
2022-01-27 03:28:22 +01:00
b2c366d946 docs(org): fix typo in capture example 2022-01-13 21:49:34 +01:00
23503cfb44 docs(haskell): fix docs for alternative formatter
Small fixup to use the proper form when setting an alternative
formatter using the `after!` macro
2022-01-05 15:08:29 +01:00
c9399c1a19 docs(coq): expand README
+ Hack: Abbrevs are replaced with snippets
+ Installation: To enable completion you also need :completion company
+ Installation: coqtop is required, link to coq download site
+ Troubleshooting: Link to related github issues
2022-01-05 04:04:21 +01:00
7423eef243 docs(lookup): fix typos 2022-01-03 18:05:56 +01:00
a5f8d44d15 docs(magit): add docs for #5846
Ref: #5846
2021-12-15 15:17:45 +01:00
f6ee39abe3 docs(vertico): fix #+CREATED and #+SINCE keywords
They were generated using a subsequent Vertico PR, not the one that
added the module.
2021-11-24 13:07:22 +01:00
08071f92b7 docs(doom): fix doom-variable-pitch-font reference
Fixes doom-variable-font so it is consistent with the actual
variable used within doom, which is 'doom-variable-pitch-font'.
2021-11-21 20:04:28 +01:00
2236c3bcda docs(rust): rustic-format-{on-save,trigger}
Ref: #5800
Co-authored-by: brotzeit <brotzeitmacher@gmail.com>
2021-11-21 20:04:28 +01:00
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
1decc38237 docs: fix module readme CREATED & SINCE attrs
Some were missing PR references, others had incorrect values for SINCE
and CREATED attributes. Also corrects the capitalization in some
SUBTITLEs.
2021-11-21 20:04:28 +01:00