Commit graph

10775 commits

Author SHA1 Message Date
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
c34168fb2a
docs(lsp): flesh out lsp-mode vs eglot comparison 2022-08-02 19:35:54 +02:00
Henrik Lissner
24fab1242a
docs(rest): mention +jq flag 2022-08-02 19:35:54 +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
9744946a66
docs(ligatures): mention doom-unicode-font incompatibilities 2022-08-02 16:23:42 +02:00
Dominic Martinez
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
Anh T Nguyen
fd6056bc23 docs(org): add reference to evil-org keybindings 2022-06-21 20:27:26 +02:00
Artem Smaznov
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
Jeetaditya Chatterjee
cf0696f54b docs(fold): mention ts-fold package 2022-06-18 00:16:31 +02:00
Itai Y. Efrat
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
noisycomputation
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
Itai Y. Efrat
8d8ec41c5c docs(agda): document +local flag 2022-04-12 02:31:50 +02:00
Anh T Nguyen
6fcb99b35a docs(company): code completion with multiple keywords 2022-03-19 16:38:27 +01: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
Henrik Lissner
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
Anh T Nguyen
97ac670881
docs(snippets): document how to write your own snippets 2022-01-30 02:42:13 +01:00
wangggong
402e5eb723
docs(modeline): mention modeline hiding & strange icons
Ref: #1166
2022-01-29 20:09:50 +01:00
Anh T Nguyen
0451c9b0bc
docs(lsp): link to LSP tuning guide 2022-01-29 20:08:17 +01:00
Anh T Nguyen
8fa1f4bb6b docs(mu4e): enable automatic email fetching 2022-01-27 18:42:19 +01:00
Prashant Tak
4bdcf48a0b
docs(org): add org-pretty-table to readme
Ref: #6033
Amend: 53ea2e4ce2b8
2022-01-27 16:30:47 +01:00
Kiran Shila
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
Sage Raflik
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
Nicolas Cavigneaux
b2c366d946 docs(org): fix typo in capture example 2022-01-13 21:49:34 +01:00
Carlos D'Agostino
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
Michalis Pardalos
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
Zero King
7423eef243 docs(lookup): fix typos 2022-01-03 18:05:56 +01:00
Ellis Kenyő
a5f8d44d15
docs(magit): add docs for #5846
Ref: #5846
2021-12-15 15:17:45 +01:00
Itai Y. Efrat
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
Roch D'Amour
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
Henrik Lissner
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
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
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
Henrik Lissner
3766523f1e docs: move modules.org to modules/README.org
And regenerate the module list using 'doom make-index $EMACSIR/modules'.
2021-11-21 20:04:28 +01:00
Henrik Lissner
7bc0033d0a docs: add doom-docs-mode & doom-docs-org-mode
These two modes exist to provide a nicer reading experience while
viewing Doom's org documentation from within Emacs; they hide
meta-lines, comments, markup, and more.

They also enable our docs to use IDs for links and keep our ID db
separate from any user ID dbs.
2021-11-21 20:04:28 +01:00
Henrik Lissner
b5a2aa48fe docs(:ui): update READMEs to new format 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
a226655486 docs(:term): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
f6335befb4 docs(:os): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
20cac97c08 docs(:lang): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
ca7579a1e9 docs(:input): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
2dcef764f1 docs(:email): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
73c1dd1338 docs(:emacs): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
9ada400805 docs(:editor): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
c27f005011 docs(:config): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
11793094ba docs(:completion): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
b898fbe303 docs(:checkers): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
5b354ae4f3 docs(:app): update READMEs to new format 2021-11-21 20:04:28 +01:00
Henrik Lissner
0aad1399cc refactor(file-templates): doom readme templates
Including readme template for categories.
2021-11-21 20:04:28 +01:00
Henrik Lissner
df62fcba26 docs: add category readmes 2021-11-21 20:04:28 +01:00
Luis
3231db863c fix(dart): remove hardcoded path to flutter SDK
Instead, flutter.el looks for the executable in PATH.
2021-11-21 19:05:38 +01:00