forked from doomemacs/doomemacs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(:lang): update READMEs to new format
- Loading branch information
Showing
61 changed files
with
4,376 additions
and
2,749 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::lang nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]] | ||
← [[doom-module-index:][Back to module index]] ↖ [[doom-module-source:lang][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]] | ||
-------------------------------------------------------------------------------- | ||
#+TITLE: :lang | ||
#+CREATED: August 3, 2021 | ||
#+SINCE: v21.12.0 | ||
#+SETUPFILE: ../../docs/.setupfile.org | ||
#+TITLE: :lang | ||
#+CREATED: August 03, 2021 | ||
#+SINCE: 21.12.0 | ||
|
||
* Description | ||
These modules specialize in adding language support to Emacs. | ||
These modules specialize in integration particular languages and their | ||
ecosystems into (Doom) Emacs. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,54 @@ | ||
#+TITLE: :lang agda | ||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::lang agda][Issues]] ↖ [[doom-module-source:lang/agda][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]] | ||
-------------------------------------------------------------------------------- | ||
#+TITLE: :lang agda | ||
#+SUBTITLE: Types of types of types of types... | ||
#+CREATED: August 21, 2018 | ||
#+SINCE: 21.12.0 (#821) | ||
|
||
* Description :unfold: | ||
This module adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php][agda]] programming language. The Emacs support | ||
exists directly in the agda repository but not in melpa. | ||
exists directly in the agda repository, but not in melpa. | ||
|
||
** Maintainers | ||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]] | ||
|
||
** Module flags | ||
/This module has no flags./ | ||
|
||
** Packages | ||
- unless [[doom-module:][+local]] | ||
- [[doom-package:][agda-input]] | ||
- [[doom-package:][agda2-mode]] | ||
|
||
** Hacks | ||
/No hacks documented for this module./ | ||
|
||
** TODO Changelog | ||
# This section will be machine generated. Don't edit it by hand. | ||
/This module does not have a changelog yet./ | ||
|
||
* Installation | ||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]] | ||
|
||
/This module has no external requirements./ | ||
|
||
* TODO Usage | ||
#+begin_quote | ||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]] | ||
#+end_quote | ||
|
||
* TODO Configuration | ||
#+begin_quote | ||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]] | ||
#+end_quote | ||
|
||
* Troubleshooting | ||
/There are no known problems with this module./ [[doom-report:][Report one?]] | ||
|
||
* Frequently asked questions | ||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]] | ||
|
||
* TODO Appendix | ||
#+begin_quote | ||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]] | ||
#+end_quote |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,59 @@ | ||
#+TITLE: lang/beancount | ||
#+DATE: April 13, 2021 | ||
#+SINCE: v3.0.0 | ||
#+STARTUP: inlineimages nofold | ||
|
||
* Table of Contents :TOC_3:noexport: | ||
- [[#description][Description]] | ||
- [[#maintainers][Maintainers]] | ||
- [[#module-flags][Module Flags]] | ||
- [[#plugins][Plugins]] | ||
- [[#hacks][Hacks]] | ||
- [[#prerequisites][Prerequisites]] | ||
- [[#features][Features]] | ||
- [[#configuration][Configuration]] | ||
- [[#troubleshooting][Troubleshooting]] | ||
|
||
* Description | ||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::lang beancount][Issues]] ↖ [[doom-module-source:lang/beancount][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]] | ||
-------------------------------------------------------------------------------- | ||
#+TITLE: :lang beancount | ||
#+SUBTITLE: Mind the GAAP | ||
#+CREATED: April 13, 2021 | ||
#+SINCE: 21.12.0 | ||
|
||
* Description :unfold: | ||
This module adds support for [[https://beancount.github.io/][Beancount]] to Emacs. Beancount, like ledger, lets | ||
you [[https://plaintextaccounting.org/][manage your money in plain text]]. | ||
|
||
+ Supports [[https://github.com/polarmutex/beancount-language-server][beancount-language-server]] (if module is enabled with the =+lsp= | ||
flag). | ||
|
||
** Maintainers | ||
This module has no dedicated maintainers. | ||
- @hlissner | ||
|
||
[[doom-contrib-maintainer:][Become a maintainer?]] | ||
|
||
** Module Flags | ||
+ =+lsp= Enable support for [beancount-language-server]. Requires Doom's =:tools | ||
lsp= module. | ||
** Module flags | ||
- +lsp :: | ||
Enable LSP support for ~beancount-mode~. Requires [[doom-module:][:tools lsp]] and a langserver | ||
(supports [[https://github.com/polarmutex/beancount-language-server][beancount-language-server]]). | ||
|
||
** Plugins | ||
+ [[https://github.com/beancount/beancount-mode][beancount]] | ||
** Packages | ||
- [[doom-package:][beancount]] | ||
|
||
** Hacks | ||
+ Associates the material =attach_money= icon with *.beancount files in the | ||
=all-the-icons= package. | ||
- Associates the material =attach_money= icon with =*.beancount= files in the | ||
[[doom-package:][all-the-icons]] package. | ||
|
||
** TODO Changelog | ||
# This section will be machine generated. Don't edit it by hand. | ||
/This module does not have a changelog yet./ | ||
|
||
* Prerequisites | ||
This module has no hard prerequisites, but assumes you have [[https://github.com/beancount/beancount][beancount]] installed | ||
in order to generate reports with ~bean-report~. | ||
* Installation | ||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]] | ||
|
||
This module requires: | ||
- [[https://github.com/beancount/beancount][beancount]], for generating reports | ||
- [[https://beancount.github.io/fava/][fava]], for a web interface for your ledgers | ||
|
||
* TODO Usage | ||
#+begin_quote | ||
Also: the ~beancount-fava~ command requires [[https://beancount.github.io/fava/][fava]]. | ||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]] | ||
#+end_quote | ||
|
||
* TODO Features | ||
# An in-depth list of features, how to use them, and their dependencies. | ||
|
||
* TODO Configuration | ||
# How to configure this module, including common problems and how to address them. | ||
#+begin_quote | ||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]] | ||
#+end_quote | ||
|
||
* Troubleshooting | ||
/There are no known problems with this module./ [[doom-report:][Report one?]] | ||
|
||
* Frequently asked questions | ||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]] | ||
|
||
* TODO Troubleshooting | ||
# Common issues and their solution, or places to look for help. | ||
* TODO Appendix | ||
#+begin_quote | ||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]] | ||
#+end_quote |
Oops, something went wrong.