chore(kb): marginally improve articles

This commit is contained in:
Michele Cereda
2024-05-12 11:44:14 +02:00
parent 8ef68525ad
commit 29d16f72fe
2 changed files with 30 additions and 11 deletions

View File

@@ -9,7 +9,7 @@ A multi-machine dotfile manager, written in Go.
1. [Gotchas](#gotchas) 1. [Gotchas](#gotchas)
1. [Snippets](#snippets) 1. [Snippets](#snippets)
1. [Further readings](#further-readings) 1. [Further readings](#further-readings)
1. [Sources](#sources) 1. [Sources](#sources)
## TL;DR ## TL;DR
@@ -132,22 +132,20 @@ $
- [Go text/template] - [Go text/template]
- [Sprig] - [Sprig]
## Sources ### Sources
All the references in the [further readings] section, plus the following:
- [Source state attributes]
- [cheat.sh] - [cheat.sh]
- [custom data fields appear as all lowercase strings] - [Custom data fields appear as all lowercase strings]
<!-- <!--
References References
--> -->
<!-- In-article sections --> <!-- In-article sections -->
[further readings]: #further-readings
<!-- Upstream --> <!-- Upstream -->
[user guide]: https://www.chezmoi.io/user-guide/setup/ [user guide]: https://www.chezmoi.io/user-guide/setup/
[source state attributes]: https://www.chezmoi.io/reference/source-state-attributes/
<!-- Others --> <!-- Others -->
[cheat.sh]: https://cheat.sh/chezmoi [cheat.sh]: https://cheat.sh/chezmoi

View File

@@ -2,26 +2,47 @@
Gives warnings and suggestions about `bash`/`sh` shell scripts. Gives warnings and suggestions about `bash`/`sh` shell scripts.
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr) 1. [TL;DR](#tldr)
1. [Further readings](#further-readings) 1. [Further readings](#further-readings)
## TL;DR ## TL;DR
<details>
<summary>Installation and configuration</summary>
```sh ```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 ## Further readings
- [Website] - [Website]
- [Github] - [Github]
<!-- <!--
References Reference
═╬═Time══
--> -->
<!-- In-article sections -->
<!-- Knowledge base -->
<!-- Files -->
<!-- Upstream --> <!-- Upstream -->
[github]: https://github.com/koalaman/shellcheck [github]: https://github.com/koalaman/shellcheck
[website]: https://www.shellcheck.net/ [website]: https://www.shellcheck.net/
<!-- Others -->