Commit Graph

29 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
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
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
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
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
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
20cac97c08 docs(:lang): update READMEs to new format 2021-11-21 20:04:28 +01:00
f3c3459ecd Update suggested clangd flags in lang/cc docs 2021-05-19 21:41:09 +02:00
d2a5d2f2aa [doc: modules/lang/cc] Readability improvements (#4637)
* Readability improvements

NOTE: Projects are assumed to be under a non-root user. If there's a use case for keeping projects under root, let me know.

* Update README.org

* Update README.org

pushd & popd aren't existent in POSIX shell.

* Update README.org

Can't git clone if directory already exists.

* Update README.org

clang-tools NOTE seems to be inaccurate. Opt for minimal dependencies required by default instead.

* Update README.org

👀

* Update README.org

*Can* run the code blocks through Emacs if desired.

* Remove babel parameters

These would be better in `#+PROPERTY: ...`s in the header or our global `.dir-locals.el`, but no standard has been designed for it yet, so omit them until one exists.

Co-authored-by: Henrik Lissner <accounts@v0.io>
2021-02-23 19:51:47 -05:00
db2ad0828c Adding doc update for cmake-language-server 2020-11-18 06:25:36 +01:00
2bf73ee34c [:lang cc] Add LSP configuration snippets 2020-11-13 01:35:54 +01:00
0aab1118de lang/cc: revise prerequisites in readme 2020-08-21 23:18:01 -04:00
0f5c5bb288 Move and map interactive eglot/c++ function 2020-05-28 12:01:35 +02:00
be1e4015d5 Fix broken MacOS irony-mode building command.
Found same issue described here: https://www.reddit.com/r/emacs/comments/d0kxj4/ironymode_installing_server_help/
2020-01-16 21:23:35 -08:00
1968a2ad1c Fix typo in CC README (gompany -> company) 2019-10-08 20:07:44 +13:00
01fa9ec169 lang/cc: update README 2019-10-07 12:59:11 -04:00
b7a98cc788 Add openSUSE prerequisite instructions
These instructions were tested on openSUSE Tumbleweed and openSUSE Leap
15.1. There are some modules left that are not documented yet, but this
already improves the sitution for common openSUSE users.
2019-10-03 16:01:35 +02:00
62af55dad0 Move emacs-snippets -> doom-snippets
The repo was renamed upstream.
2019-07-14 17:05:48 +02:00
d4ff90219e lang/cc: remove +irony and +rtags flags from docs
They were removed a while back. Irony and rtags (et co) will be disabled
if +lsp is enabled, or can be disabled through package! declarations:

  ;; in ~/.doom.d/packages.el
  (package! irony :disable t)
  (package! rtags :disable t)
2019-04-24 18:16:05 -04:00
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
7251b50b35 Make bear-macos issue a sub-tree
Since it is directly relevant to the project-compile-settings section.
2019-01-20 14:22:45 -05:00
e02cde1195 :lang cc Add known issues section for macOS 2019-01-07 19:28:59 +01:00
9916025d5c lang/cc: rewrite README 2019-01-05 19:46:14 -05:00
b331acb46b lang/cc: rename +cc-{include-paths,compiler-options} #305 2017-12-27 17:10:28 -05:00
0da3c563b7 lang/cc: update readme #305 2017-12-27 00:36:22 -05:00
cbabf6849c Standardize module READMEs 2017-08-21 20:13:31 +02:00
e1f60b2bfd Update READMEs & add new ones 2017-05-25 20:09:12 +02:00
53138760a0 lang/cc: update README, remove bootstrap 2017-05-04 10:46:12 +02:00
505d515dd8 Add README.org's for lang/cc, app/email; update other README.org's 2017-05-04 10:40:57 +02:00