mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
chore(kb): marginally improve articles
This commit is contained in:
@@ -132,22 +132,20 @@ $
|
||||
- [Go text/template]
|
||||
- [Sprig]
|
||||
|
||||
## Sources
|
||||
|
||||
All the references in the [further readings] section, plus the following:
|
||||
### Sources
|
||||
|
||||
- [Source state attributes]
|
||||
- [cheat.sh]
|
||||
- [custom data fields appear as all lowercase strings]
|
||||
- [Custom data fields appear as all lowercase strings]
|
||||
|
||||
<!--
|
||||
References
|
||||
-->
|
||||
|
||||
<!-- In-article sections -->
|
||||
[further readings]: #further-readings
|
||||
|
||||
<!-- Upstream -->
|
||||
[user guide]: https://www.chezmoi.io/user-guide/setup/
|
||||
[source state attributes]: https://www.chezmoi.io/reference/source-state-attributes/
|
||||
|
||||
<!-- Others -->
|
||||
[cheat.sh]: https://cheat.sh/chezmoi
|
||||
|
||||
@@ -2,26 +2,47 @@
|
||||
|
||||
Gives warnings and suggestions about `bash`/`sh` shell scripts.
|
||||
|
||||
## Table of contents <!-- omit in toc -->
|
||||
|
||||
1. [TL;DR](#tldr)
|
||||
1. [Further readings](#further-readings)
|
||||
|
||||
## TL;DR
|
||||
|
||||
<details>
|
||||
<summary>Installation and configuration</summary>
|
||||
|
||||
```sh
|
||||
shellcheck /path/to/script.sh
|
||||
apt install 'shellcheck'
|
||||
brew install 'shellcheck'
|
||||
pacman -S 'shellcheck'
|
||||
zypper in 'ShellCheck'
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Usage</summary>
|
||||
|
||||
```sh
|
||||
shellcheck '/path/to/script.sh'
|
||||
shellcheck '/path/to/scripts/*.sh'
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Further readings
|
||||
|
||||
- [Website]
|
||||
- [Github]
|
||||
|
||||
<!--
|
||||
References
|
||||
Reference
|
||||
═╬═Time══
|
||||
-->
|
||||
|
||||
<!-- In-article sections -->
|
||||
<!-- Knowledge base -->
|
||||
<!-- Files -->
|
||||
<!-- Upstream -->
|
||||
[github]: https://github.com/koalaman/shellcheck
|
||||
[website]: https://www.shellcheck.net/
|
||||
|
||||
<!-- Others -->
|
||||
|
||||
Reference in New Issue
Block a user