merge: rewrite-docs

I've omitted docs/*.org from this merge, as there is still work left to
do there, but I am pushing the module docs early so folks can benefit
from the new docs sooner.
This commit is contained in:
Henrik Lissner 2022-08-03 03:23:34 +02:00
commit 1f8bf7accb
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
179 changed files with 13125 additions and 8630 deletions

View file

@ -1,47 +1,73 @@
#+TITLE: lang/sh
#+DATE: December 19, 2015
#+SINCE: v0.7
#+STARTUP: inlineimages
# -*- mode: doom-docs-org -*-
#+title: :lang sh
#+subtitle: She sells {ba,z,fi}sh shells on the C xor
#+created: September 28, 2015
#+since: 0.7
* Table of Contents :TOC:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
* Description :unfold:
This module adds support for shell scripting languages (including Powershell and
Fish script) to Doom Emacs.
* Description
This module adds support for shell scripting languages.
- Code completion ([[doom-package:][company-shell]])
- Syntax Checking ([[doom-package:][flycheck]])
+ Code completion (company-shell)
+ Syntax Checking (flycheck)
** Maintainers
- [[doom-user:][@hlissner]]
** Module Flags
+ =+lsp= Enables LSP support for sh-mode. This requires the =:tools lsp= module
to be enabled and [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]] to be installed on your system.
+ =+fish= Add syntax highlighting for fish script files.
+ =+powershell= Add syntax highlighting for Powershell script files .ps1 and .psm1
[[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags
- +fish ::
Add syntax highlighting for fish script files.
- +lsp ::
Enable LSP support for ~sh-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports bash-language-server).
- +powershell ::
Add syntax highlighting for Powershell script files (=.ps1= and =.psm1=).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Plugins
+ [[https://github.com/Alexander-Miller/company-shell][company-shell]]* (=:completion company=)
+ [[https://github.com/wwwjfy/emacs-fish][fish-mode]]* (=+fish=)
+ [[https://github.com/jschaf/powershell.el][powershell-mode]]* (=+powershell=)
** Packages
- [[doom-package:][company-shell]] if [[doom-module:][:completion company]]
- [[doom-package:][fish-mode]] if [[doom-module:][+fish]]
- [[doom-package:][powershell-mode]] if [[doom-module:][+powershell]]
** Hacks
+ Interpolated variables are fontified.
- Interpolated variables are fontified.
** 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.]]
* Prerequisites
This module has several optional dependencies:
+ [[https://github.com/koalaman/shellcheck][shellcheck]]: Enables advanced shell script linting.
+ [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]]: Enables LSP support (with =+lsp= flag).
+ With the =:tools debugger= module
+ [[http://bashdb.sourceforge.net/][bashdb]]: Enables debugging for bash scripts
+ [[https://github.com/rocky/zshdb][zshdb]]: Enables debugging for zsh scripts
- [[https://github.com/koalaman/shellcheck][shellcheck]]: Enables advanced shell script linting.
- [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]]: Enables LSP support (with [[doom-module:][+lsp]] flag).
- With the [[doom-module:][:tools debugger]] module
- [[http://bashdb.sourceforge.net/][bashdb]]: Enables debugging for bash scripts
- [[https://github.com/rocky/zshdb][zshdb]]: Enables debugging for zsh scripts
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Features
* TODO Configuration
* TODO Troubleshooting
#+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