chore: maintain the kb a little

This commit is contained in:
Michele Cereda
2024-06-08 01:31:04 +02:00
parent 1fb4ee94cf
commit 4c169eb65d
2 changed files with 66 additions and 6 deletions

View File

@@ -1,8 +1,6 @@
# Chezmoi # Chezmoi
A multi-machine dotfile manager, written in Go. Multi-machine dotfiles manager written in Go.
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr) 1. [TL;DR](#tldr)
1. [Save the current state to a remote repository](#save-the-current-state-to-a-remote-repository) 1. [Save the current state to a remote repository](#save-the-current-state-to-a-remote-repository)
@@ -14,11 +12,11 @@ A multi-machine dotfile manager, written in Go.
## TL;DR ## TL;DR
```sh ```sh
# Install Chezmoi. # Install.
brew install 'chezmoi' brew install 'chezmoi'
sudo zypper install 'chezmoi' sudo zypper install 'chezmoi'
# Initialize chezmoi. # Initialize.
chezmoi init chezmoi init
chezmoi init 'https://github.com/username/dotfiles.git' --branch 'chezmoi' chezmoi init 'https://github.com/username/dotfiles.git' --branch 'chezmoi'
@@ -82,7 +80,8 @@ $
## Gotchas ## Gotchas
- templating uses the [Go text/template] library - templating uses the [Go text/template] library
- due to a feature of a library used by chezmoi, all custom variable names in the configuration file are converted to lowercase; see the [custom data fields appear as all lowercase strings] GitHub issue for more information. - ~~Due to a feature of a library used by chezmoi, all custom variable names in the configuration file are converted to
lowercase; see the [custom data fields appear as all lowercase strings] GitHub issue for more information.~~
```toml ```toml
# configuration file # configuration file
@@ -95,6 +94,8 @@ $
map[awesomecustomfield:my Awesome custom Value chezmoi:… normallookingcustomfield:normalLookingValue] map[awesomecustomfield:my Awesome custom Value chezmoi:… normallookingcustomfield:normalLookingValue]
``` ```
> Solved in [2376](https://github.com/twpayne/chezmoi/pull/2376/files).
## Snippets ## Snippets
```go ```go

59
knowledge base/motd.md Normal file
View File

@@ -0,0 +1,59 @@
# Message Of The Day
TODO
File containing the message of the day in Unix-like operating systems.
1. [TL;DR](#tldr)
1. [Further readings](#further-readings)
1. [Sources](#sources)
## TL;DR
<!-- Uncomment if used
<details>
<summary>Installation and configuration</summary>
```sh
```
</details>
-->
<!-- Uncomment if used
<details>
<summary>Usage</summary>
```sh
```
</details>
-->
<!-- Uncomment if used
<details>
<summary>Real world use cases</summary>
```sh
```
</details>
-->
## Further readings
### Sources
- [freebsd's man page]
<!--
Reference
═╬═Time══
-->
<!-- In-article sections -->
<!-- Knowledge base -->
<!-- Files -->
<!-- Upstream -->
<!-- Others -->
[freebsd's man page]: https://man.freebsd.org/cgi/man.cgi?motd