#!/usr/bin/env bash # # Steps: # # 1. Download corresponding html file for some README.md: # curl -s $1 # # 2. Discard rows where no substring 'user-content-' (github's markup): # awk '/user-content-/ { ... # # 3.1 Get last number in each row like ' ... sitemap.js.*<\/h/)+2, RLENGTH-5) # # 5. Find anchor and insert it inside "(...)": # substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8) # gh_toc_version="0.5.0" gh_user_agent="gh-md-toc v$gh_toc_version" # # Download rendered into html README.md by its url. # # gh_toc_load() { 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 } # # Converts local md file into html by GitHub # # ➥ curl -X POST --data '{"text": "Hello world github/linguist#1 **cool**, and #1!"}' https://api.github.com/markdown #

Hello world github/linguist#1 cool, and #1!

'" gh_toc_md2html() { local gh_file_md=$1 URL=https://api.github.com/markdown/raw TOKEN="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt" if [ -f "$TOKEN" ]; then URL="$URL?access_token=$(cat $TOKEN)" fi OUTPUT="$(curl -s --user-agent "$gh_user_agent" \ --data-binary @"$gh_file_md" -H "Content-Type:text/plain" \ $URL)" if [ "$?" != "0" ]; then echo "XXNetworkErrorXX" fi if [ "$(echo "${OUTPUT}" | awk '/API rate limit exceeded/')" != "" ]; then echo "XXRateLimitXX" else echo "${OUTPUT}" fi } # # Is passed string url # gh_is_url() { case $1 in https* | http*) echo "yes";; *) echo "no";; esac } # # TOC generator # gh_toc(){ local gh_src=$1 local gh_src_copy=$1 local gh_ttl_docs=$2 local need_replace=$3 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="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt" echo "or place github auth token here: $TOKEN" exit 1 fi local toc=$(echo "$rawhtml" | gh_toc_grab "$gh_src_copy") if [ "$need_replace" = "yes" ]; then local ts="<\!--ts-->" local te="<\!--te-->" local tmp="${gh_src}.tmp" # http://fahdshariff.blogspot.ru/2012/12/sed-mutli-line-replacement-between-two.html # fix sed on mac local sed='sed -i' if [[ "`uname`" == "Darwin" ]]; then sed='sed -i ""' fi # clear old TOC $sed "/${ts}/,/${te}/{//!d;}" "$gh_src" # create toc file echo "${toc}" > "${tmp}" # count headers above ts local linesAbove=$(grep -n -- "${ts}" "${gh_src}" | cut -d: -f 1) if [ -n "$linesAbove" ]; then # skip headers above ts local skip=$(head -n "$linesAbove" "${gh_src}" | grep '^\w*#' | wc -l) $sed "1,${skip}d" "${tmp}" # unindent file local minLeadingSpaces=10000 while IFS='' read line; do local leadingSpaces=$(echo "$line" | grep -o "^\s\+" | tr -d '\n' | wc -c) if [ "$leadingSpaces" -lt "$minLeadingSpaces" ]; then minLeadingSpaces=$leadingSpaces fi done < "${tmp}" if [ "$minLeadingSpaces" -gt 0 ]; then $sed "s/^.\{${minLeadingSpaces}\}//g" "${tmp}" fi # echo "$(awk 'NR==1 && match($0, /^ +/){n=RLENGTH} {sub("^ {"n"}", "")} 1' "${tmp}")" > "${tmp}" fi # insert toc file $sed "/${ts}/r ${tmp}" "$gh_src" # delete tmp file toc=$(cat "${tmp}") rm "${tmp}" fi # echo "$toc" fi } # # Grabber of the TOC from rendered html # # $1 — a source url of document. # It's need if TOC is generated for multiple documents. # gh_toc_grab() { # if closed is on the new line, then move it on the prev line # for example: # was: The command foo1 # # became: The command foo1 sed -e ':a' -e 'N' -e '$!ba' -e 's/\n<\/h/<\/h/g' | # find strings that corresponds to template grep -E -o '//' | sed 's/<\/code>//' | # now all rows are like: # ... .*<\/h/)+2, RLENGTH-5)"](" gh_url substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8) ")"}' | sed 'y/+/ /; s/%/\\x/g')" } # # Returns filename only from full path or url # gh_toc_get_filename() { echo "${1##*/}" } # # Options hendlers # gh_toc_app() { local app_name=$(basename $0) local need_replace="no" if [ "$1" = '--help' ] || [ $# -eq 0 ] ; then 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 - 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" 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 for md in "$@" do # echo "" gh_toc "$md" "$#" "$need_replace" done # echo "" # echo "Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)" } # # Entry point # gh_toc_app "$@"