local gh_url=$1

if type curl &>/dev/null; then

curl --user-agent "$gh_user_agent" -s "$gh_url"

elif type wget &>/dev/null; then

wget --user-agent="$gh_user_agent" -qO- "$gh_url"

else

echo "Please, install 'curl' or 'wget' and try again."

exit 1

fi

local gh_file_md=$1

URL=https://api.github.com/markdown/raw

if [ ! -z "$GH_TOC_TOKEN" ]; then

TOKEN=$GH_TOC_TOKEN

else

TOKEN_FILE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt"

if [ -f "$TOKEN_FILE" ]; then

TOKEN="$(cat $TOKEN_FILE)"

fi

fi

if [ ! -z "${TOKEN}" ]; then

AUTHORIZATION="--header \"Authorization: token ${TOKEN}\""

fi

# echo $URL 1>&2

OUTPUT="$(curl -s --user-agent "$gh_user_agent" \

if [ "$?" != "0" ]; then

echo "XXNetworkErrorXX"

fi

if [ "$(echo "${OUTPUT}" | awk '/API rate limit exceeded/')" != "" ]; then

echo "XXRateLimitXX"

else

echo "${OUTPUT}"

fi

case $1 in

https* | http*)

echo "yes";;

*)

echo "no";;

esac

local gh_src=$1

local gh_src_copy=$1

local gh_ttl_docs=$2

local need_replace=$3

local no_backup=$4

if [ "$gh_src" = "" ]; then

echo "Please, enter URL or local path for a README.md"

exit 1

fi

# Show "TOC" string only if working with one document

if [ "$gh_ttl_docs" = "1" ]; then

echo "Table of Contents"

echo "================="

echo ""

gh_src_copy=""

fi

if [ "$(gh_is_url "$gh_src")" == "yes" ]; then

gh_toc_load "$gh_src" | gh_toc_grab "$gh_src_copy"

if [ "${PIPESTATUS[0]}" != "0" ]; then

echo "Could not load remote document."

echo "Please check your url or network connectivity"

exit 1

fi

if [ "$need_replace" = "yes" ]; then

echo

echo "!! '$gh_src' is not a local file"

echo "!! Can't insert the TOC into it."

echo

fi

else

local rawhtml=$(gh_toc_md2html "$gh_src")

if [ "$rawhtml" == "XXNetworkErrorXX" ]; then

echo "Parsing local markdown file requires access to github API"

echo "Please make sure curl is installed and check your network connectivity"

exit 1

fi

if [ "$rawhtml" == "XXRateLimitXX" ]; then

echo "Parsing local markdown file requires access to github API"

echo "Error: You exceeded the hourly limit. See: https://developer.github.com/v3/#rate-limiting"

TOKEN_FILE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt"

echo "or place GitHub auth token here: ${TOKEN_FILE}"

exit 1

fi

local toc=`echo "$rawhtml" | gh_toc_grab "$gh_src_copy"`

echo "$toc"

if [ "$need_replace" = "yes" ]; then

if grep -Fxq "<!--ts-->" $gh_src && grep -Fxq "<!--te-->" $gh_src; then

echo "Found markers"

else

echo "You don't have <!--ts--> or <!--te--> in your file...exiting"

exit 1

fi

local ts="<\!--ts-->"

local te="<\!--te-->"

local dt=`date +'%F_%H%M%S'`

local ext=".orig.${dt}"

local toc_path="${gh_src}.toc.${dt}"

local toc_footer="<!-- Added by: `whoami`, at: `date` -->"

# http://fahdshariff.blogspot.ru/2012/12/sed-mutli-line-replacement-between-two.html

# https://opus.konghy.cn/sed-refer/ 关于 {} 的使用和分号的使用

# 或者耗子叔的 https://coolshell.cn/articles/9104.html 搜索 命令打包

# clear old TOC

sed -i${ext} "/${ts}/,/${te}/{//!d;}" "$gh_src"

# create toc file

echo "${toc}" > "${toc_path}"

echo -e "\n${toc_footer}\n" >> "$toc_path"

# insert toc file

if [[ "`uname`" == "Darwin" ]]; then

sed -i "" "/${ts}/r ${toc_path}" "$gh_src"

else

sed -i "/${ts}/r ${toc_path}" "$gh_src"

fi

echo

if [ $no_backup = "yes" ]; then

rm ${toc_path} ${gh_src}${ext}

fi

echo "!! TOC was added into: '$gh_src'"

if [ -z $no_backup ]; then

echo "!! Origin version of the file: '${gh_src}${ext}'"

echo "!! TOC added into a separate file: '${toc_path}'"

fi

echo

fi

fi

# if closed <h[1-6]> is on the new line, then move it on the prev line

# for example:

# was: The command <code>foo1</code>

# </h1>

# became: The command <code>foo1</code></h1>

sed -e ':a' -e 'N' -e '$!ba' -e 's/\n<\/h/<\/h/g' |

# find strings that corresponds to template

grep -E -o '<a.*id="user-content-[^"]*".*</h[1-6]' |

# remove code tags

sed 's/<code>//g' | sed 's/<\/code>//g' |

# now all rows are like:

# <a id="user-content-..." href="..."><span ...></span></a> ... </h1

# format result line

# * $0 — whole string

# * last element of each row: "</hN" where N in (1,2,3,...)

echo -e "$(awk -v "gh_url=$1" '{

local need_replace="no"

if [ "$1" = '--help' ] || [ $# -eq 0 ] ; then

local app_name=$(basename "$0")

echo "GitHub TOC generator ($app_name): $gh_toc_version"

echo ""

echo "Usage:"

echo " $app_name [--insert] src [src] Create TOC for a README file (url or local path)"

echo " $app_name [--no-backup] src [src] Create TOC without backup, requires <!--ts--> / <!--te--> placeholders"

echo " $app_name - Create TOC for markdown from STDIN"

echo " $app_name --help Show help"

echo " $app_name --version Show version"

return

fi

if [ "$1" = '--version' ]; then

echo "$gh_toc_version"

echo

echo "os: `lsb_release -d | cut -f 2`"

echo "kernel: `cat /proc/version`"

echo "shell: `$SHELL --version`"

echo

for tool in curl wget grep awk sed; do

printf "%-5s: " $tool

echo `$tool --version | head -n 1`

done

return

fi

if [ "$1" = "-" ]; then

if [ -z "$TMPDIR" ]; then

TMPDIR="/tmp"

elif [ -n "$TMPDIR" -a ! -d "$TMPDIR" ]; then

mkdir -p "$TMPDIR"

fi

local gh_tmp_md

gh_tmp_md=$(mktemp $TMPDIR/tmp.XXXXXX)

while read input; do

echo "$input" >> "$gh_tmp_md"

done

gh_toc_md2html "$gh_tmp_md" | gh_toc_grab ""

return

fi

if [ "$1" = '--insert' ]; then

need_replace="yes"

shift

fi

if [ "$1" = '--no-backup' ]; then

need_replace="yes"

no_backup="yes"

shift

fi

for md in "$@"

do

echo ""

gh_toc "$md" "$#" "$need_replace" "$no_backup"

done

echo ""

echo "Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)"

local readmeFile="$(pwd)/README.md"

local readmeBak="$(pwd)/README.md.bak"

local tocFile="$(pwd)/README.md.toc"

local tmp="$(pwd)/tmp"

local begin="<!--ts-->"

local end="<!--te-->"

if [ ! -e "$tocFile" ]; then

touch "$tocFile"

else

> "$tocFile"

fi

# shellcheck disable=SC2162

while read line; do

if [ "${line:0:4}" == "### " ];then

name=$(echo "$line" | awk -F "[" '{print $2}' | awk -F "]" '{print $1}')

echo "* [$name](#$name)" >> "$tocFile"

fi

done < "$readmeFile" # 读入的是 readme 文件，写入的是 toc 文件

# write tocFile content to readmeFile between <!--ts--> and <!--te-->

# clear old toc

# 这个地方有个疑问为解决，原代码，此文件第 168 行左右删除两行之间的数据（不包括两行）没有看明白，因此

# 使用了这个拙劣的方法，用了一个中间的 tmp 文件

sed -n "1,/${begin}/p;/${end}/,$ p" "${readmeFile}" > "${tmp}"

> "${readmeFile}"

cat "${tmp}" > "${readmeFile}"

# 现在明白了具体的原因了

# 是指首先匹配 begin 和 end 对应的范围，然后这个范围内，匹配 begin，使用 n 移动到下一行，然后匹配 end 行，匹配到这一行后，把不是

# 这一行的都删掉, 下面是执行的语句

# sed -i '.tmp' "/${begin}/,/${end}/{/${begin}/n;/${end}/!d}" "${readmeFile}"

# write new toc

# 这里使用 "" 的目的是，Mac 下需要指定一个备份文件，就算为空也要指定, 这里 r 的意思是指从后面对应的文件读入数据

# 详见：http://c.biancheng.net/view/4028.html

sed -i "" "/${begin}/r ${tocFile}" "${readmeFile}"

[ -f "${tocFile}" ] && rm -rf "${tocFile}"

[ -f "${readmeBak}" ] && rm -rf "${readmeBak}"

[ -f "${tmp}" ] && rm -rf "${tmp}"