Commit graph

21 commits

Author SHA1 Message Date
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
893434a5db
tweak(docs): org-display-remote-inline-images = 'cache
In doom-docs-org-mode buffers.
2022-08-03 02:46:32 +02:00
Henrik Lissner
64496a6c66
refactor(docs): tidy up 2022-08-03 02:46:32 +02:00
Henrik Lissner
acf7a8a48d
feat(docs): add org-glossary support 2022-08-02 21:37:15 +02:00
Henrik Lissner
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
Henrik Lissner
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
Henrik Lissner
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
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
514400215f
refactor(docs): s/doom--docs-/doom-docs--/ 2022-08-02 19:35:54 +02:00
Henrik Lissner
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
Henrik Lissner
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
Henrik Lissner
3deba740d3
feat(docs): add face:X link type to docs
For linking face symbols to documentation.
2022-08-02 16:24:36 +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
cee641ddc8
feat(docs): hide leading stars 2022-08-02 16:23:42 +02:00
Henrik Lissner
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
Henrik Lissner
4661ea89f2
tweak(docs): move point to first heading on visit 2022-08-02 16:23:42 +02:00
Henrik Lissner
c4b7071397
fix(docs): don't hide src blocks indiscriminately 2022-08-02 16:23:42 +02:00
Henrik Lissner
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
Henrik Lissner
1daecbe59c fix(lib): cache errors in doom-docs-mode 2022-02-01 18:55:27 +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
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