Move pages under tldr, lint run.sh, update docs

.github/README.md

@@ -15,10 +15,10 @@ git clone https://github.com/ivuorinen/cheatsheet-tldr.git ~/.cheat/cheatsheets/
 Configure your `cheat.yaml` to include the cheatsheets:
 
 ```yaml
-  - name: tldr
+- name: tldr
-    path: ~/.cheat/cheatsheets/tldr
+  path: ~/.cheat/cheatsheets/tldr/tldr
-    tags: [tldr]
+  tags: [tldr]
-    readonly: true
+  readonly: true
 ```
 
 ## Usage
@@ -33,4 +33,4 @@ cheat --tags tldr
 ## License
 
 Files under `.github/` are licensed under the [MIT License](LICENSE.md).
-TLDR pages licensed under [CC-BY-4.0](https://github.com/tldr-pages/tldr/blob/main/LICENSE.md).
+TLDR pages under `tldr/` licensed under [CC-BY-4.0](https://github.com/tldr-pages/tldr/blob/main/LICENSE.md).

.github/run.sh

@@ -6,7 +6,7 @@
 # TLDR pages licensed under CC-BY-4.0
 #  https://github.com/tldr-pages/tldr/blob/main/LICENSE.md
 
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
 echo "Running: $DIR/run.sh"
 echo "Working directory: $DIR"
@@ -17,56 +17,56 @@ TLDR_GIT="https://github.com/tldr-pages/tldr.git"
 TLDR_SOURCE="source: $TLDR_GIT"
 TLDR_SYNTAX="syntax: markdown"
 TLDR_TEMP_DIR="$(realpath "$DIR"/..)/__tldr-temp"
-TLDR_CHEAT_DEST="$(realpath "$DIR"/../)"
+TLDR_CHEAT_DEST="$(realpath "$DIR"/../tldr)"
 
 if [ -d "$TLDR_TEMP_DIR" ]; then
-  rm -rf "$TLDR_TEMP_DIR"
+	rm -rf "$TLDR_TEMP_DIR"
 fi
 
 echo "TLDR_TEMP_DIR: $TLDR_TEMP_DIR"
 echo "TLDR_CHEAT_DEST: $TLDR_CHEAT_DEST"
 
 git clone \
-  --depth 1 \
+	--depth 1 \
-  --single-branch \
+	--single-branch \
-  -q "$TLDR_GIT" "$TLDR_TEMP_DIR" || exit 1
+	-q "$TLDR_GIT" "$TLDR_TEMP_DIR" || exit 1
 
 rm -rf "$TLDR_TEMP_DIR/pages.*"
 
 for d in "$TLDR_TEMP_DIR"/pages/*; do
-  DIRNAME=$(basename "$d")
+	DIRNAME=$(basename "$d")
-  # echo "-> $DIRNAME ($d)"
+	# echo "-> $DIRNAME ($d)"
 
-  SECTION_DIR="${TLDR_CHEAT_DEST}/$DIRNAME"
+	SECTION_DIR="${TLDR_CHEAT_DEST}/$DIRNAME"
 
-  [ "$DIRNAME" = "common" ] && SECTION_DIR="${TLDR_CHEAT_DEST}"
+	[ "$DIRNAME" = "common" ] && SECTION_DIR="${TLDR_CHEAT_DEST}"
 
-  TLDR_TAGS="tags: [tldr, $DIRNAME]"
+	TLDR_TAGS="tags: [tldr, $DIRNAME]"
 
-  if [ ! -d "$SECTION_DIR" ]; then
+	if [ ! -d "$SECTION_DIR" ]; then
-    mkdir -p "$SECTION_DIR"
+		mkdir -p "$SECTION_DIR"
-  fi
+	fi
 
-  for FILE in "$d"/*.md; do
+	for FILE in "$d"/*.md; do
-    BASENAME=$(basename "$FILE" .md)
+		BASENAME=$(basename "$FILE" .md)
-    # FILENAME="${BASENAME%%.*}"
+		# FILENAME="${BASENAME%%.*}"
-    # echo "-> $FILE = $FILENAME"
+		# echo "-> $FILE = $FILENAME"
-    TLDR_FILE="$SECTION_DIR/${BASENAME}"
+		TLDR_FILE="$SECTION_DIR/${BASENAME}"
-    # echo "-> dest: $TLDR_FILE"
+		# echo "-> dest: $TLDR_FILE"
 
-    # Update the original file for making the replaceable value comparable
+		# Update the original file for making the replaceable value comparable
-    if [ -f "$FILE" ] && [ '---' != "$(head -1 < "$FILE")" ]; then
+		if [ -f "$FILE" ] && [ '---' != "$(head -1 <"$FILE")" ]; then
-      echo -e "---\n$TLDR_SYNTAX\n$TLDR_TAGS\n$TLDR_SOURCE\n---\n$(cat "$FILE")" > "$FILE"
+			echo -e "---\n$TLDR_SYNTAX\n$TLDR_TAGS\n$TLDR_SOURCE\n---\n$(cat "$FILE")" >"$FILE"
-    fi
+		fi
 
-    replaceable "$FILE" "$TLDR_FILE"
+		replaceable "$FILE" "$TLDR_FILE"
 
-    override=$?
+		override=$?
-    if [ "$override" -ne 0 ]; then
+		if [ "$override" -ne 0 ]; then
-      cp "$FILE" "$TLDR_FILE" && echo "Updated: $TLDR_FILE"
+			cp "$FILE" "$TLDR_FILE" && echo "Updated: $TLDR_FILE"
-    fi
+		fi
 
-  done
+	done
 done
 
 rm -rf "$TLDR_TEMP_DIR"

.gitignore

@@ -1 +1,2 @@
 __tldr-temp
+!*-secret