Skip to content

Instantly share code, notes, and snippets.

@andriilive
Last active March 22, 2024 03:50
Show Gist options
  • Save andriilive/386a69a2ea0e30822bcaa7ba1f597542 to your computer and use it in GitHub Desktop.
Save andriilive/386a69a2ea0e30822bcaa7ba1f597542 to your computer and use it in GitHub Desktop.
readme-md.sh
#!/usr/bin/env bash
# NAVIGATE TO REPO ROOT
BASE_DIR="$(git rev-parse --show-toplevel)"
cd "$BASE_DIR" || exit
echo "BASE_DIR: $BASE_DIR"
# INSTALL
npm i md-file-tree
# TREE
md-file-tree -e > "$BASE_DIR/docs/README/tree.md"
# README MERGE
cat "$BASE_DIR/docs/README/start.md" "$BASE_DIR/docs/README/tree.md" "$BASE_DIR/docs/README/end.md" > "$BASE_DIR/README.md"

readme-md.sh

Files tree generation for README.md

mkdir -p docs/README
touch docs/README/start.md
touch docs/README/tree.md
touch docs/README/end.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment