md-toc/asciinema/md_toc_asciinema_8_1_0_demo.sh

#!/bin/bash

#
# python -m md_toc_asciinema_8_1_0_demo.sh
#
# Copyright (C) 2021 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
#
# This file is part of md-toc.
#
# md-toc is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# md-toc is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with md-toc.  If not, see <http://www.gnu.org/licenses/>.
#

# Discover python -m md_toc of this repository not the one installed on the system.
export PYTHONPATH='..'
TIMEOUT=1

gen_foo()
{
    cat <<-EOF > foo.md
# Hi

<!--TOC-->

hey

## How are you?           !!!

## fine, thanks

### Bye

## <small>__Bye bye__ **bye***</small>

\`\`\`python
# This is a code
# fence with comments that might represent ATX-style headings
# if not properly parsed
\`\`\`

bye

# boo

# a string              with                lots of spaces.
EOF
}

gen_foo_noncoherent()
{
    cat <<-EOF > foo_noncoherent.md
# Hi
### boo
EOF
}

gen_foo_skiplines()
{
cat <<-EOF > foo_skiplines.md
# I want this line to be a comment
#### And this as well
## And this
###### ByeBye

# Hi
## How
### Are
## You
# Today ?
EOF
}

###
###

printf "Running a demo to show some of python -m md_toc's capabilities...\n"
printf "\n"
sleep ${TIMEOUT}

printf "$ python -m md_toc -h\n"
python -m md_toc -h
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "1. inspecting the file...\n"
printf "$ cat foo.md\n"
cat foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "2. run with default options...\n"
printf "$ python -m md_toc github foo.md\n"
python -m md_toc github foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "3. ordered list...\n"
printf "$ python -m md_toc gitlab -o '.' foo.md\n"
python -m md_toc gitlab -o '.' foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "4. constant ordered list...\n"
printf "$ python -m md_toc github -c -o '.' foo.md\n"
python -m md_toc github -c -o '.' foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "5. no links...\n"
printf "$ python -m md_toc -l github foo.md\n"
python -m md_toc -l github foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "6. no links and no indentation...\n"
printf "$ python -m md_toc -l -i github foo.md\n"
python -m md_toc -l -i github foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo_noncoherent
printf "7. inspecting the non-coherent file...\n"
printf "$ cat foo_noncoherent.md\n"
cat foo_noncoherent.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo_noncoherent
printf "8. trying to parse a non coherent markdown file will raise an exception...\n"
printf "$ python -m md_toc github foo_noncoherent.md\n"
python -m md_toc github foo_noncoherent.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo_noncoherent
printf "9. try to parse a non coherent markdown file without checking for coherence...\n"
printf "$ python -m md_toc -c github foo_noncoherent.md\n"
python -m md_toc -c github foo_noncoherent.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

printf "10. use stdin, no links and no indentation...\n"
printf "$ cat foo.md | python -m md_toc -l -i - cmark -u '*'\n"
cat foo.md | python -m md_toc -l -i cmark -u '*'
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo_skiplines
printf "11. inspecting a file where the first 5 lines need to be skipped...\n"
printf "$ cat foo_skiplines.md\n"
cat foo_skiplines.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo_skiplines
printf "12. using the skip lines option...\n"
printf "$ python -m md_toc -s 5 github foo_skiplines.md\n"
python -m md_toc -s 5 github foo_skiplines.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "13. showing GitLab's removal of consecutive dashes in the link destination...\n"
printf "$ python -m md_toc gitlab -l 6 foo.md\n"
python -m md_toc gitlab -l 6 foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "14. editing file in place with a custom newline...\n"
printf "$ python -m md_toc --newline '\\\r\\\n' -p gitlab -l 6 foo.md\n"
python -m md_toc --newline '\r\n' -p gitlab -l 6 foo.md
printf "\n"
printf "$ cat --show-nonprinting --show-ends foo.md\n"
cat --show-nonprinting --show-ends foo.md
printf "\n~~~~\n"
sleep ${TIMEOUT}

gen_foo
printf "15. editing the file in-place. As you can see, code fence \
detection still needs to be implemented for redcarpet...\n"
printf "$ python -m md_toc -p redcarpet foo.md\n"
python -m md_toc -p redcarpet foo.md
printf "$ cat foo.md\n"
cat foo.md

rm foo.md foo_noncoherent.md foo_skiplines.md