Browse Source

Added asciinema files. Updated readme. Updated contributing file.

master 6.0.0
Franco Masotti 3 years ago
parent
commit
c12afdf222
  1. 4
      README.rst
  2. 1
      asciinema/md_toc_asciinema_1_0_0_demo.sh
  3. 1
      asciinema/md_toc_asciinema_2_0_0_demo.sh
  4. 1
      asciinema/md_toc_asciinema_3_0_0_demo.sh
  5. 1
      asciinema/md_toc_asciinema_3_1_0_demo.sh
  6. 3
      asciinema/md_toc_asciinema_5_0_0_demo.sh
  7. 43
      asciinema/md_toc_asciinema_6_0_0.json
  8. 154
      asciinema/md_toc_asciinema_6_0_0_demo.sh
  9. 7
      docs/contributing.rst

4
README.rst

@ -30,8 +30,8 @@ improve document readability.
Video
-----
.. image:: https://asciinema.org/a/240852.png
:target: https://asciinema.org/a/240852
.. image:: https://asciinema.org/a/251312.png
:target: https://asciinema.org/a/251312
:align: center
Description

1
asciinema/md_toc_asciinema_1_0_0_demo.sh

@ -4,7 +4,6 @@
# md_toc_asciinema_1_0_0_demo.sh
#
# Copyright (C) 2017-2018 frnmst (Franco Masotti) <franco.masotti@live.com>
# <franco.masotti@student.unife.it>
#
# This file is part of md-toc.
#

1
asciinema/md_toc_asciinema_2_0_0_demo.sh

@ -4,7 +4,6 @@
# md_toc_asciinema_2_0_0_demo.sh
#
# Copyright (C) 2017-2018 frnmst (Franco Masotti) <franco.masotti@live.com>
# <franco.masotti@student.unife.it>
#
# This file is part of md-toc.
#

1
asciinema/md_toc_asciinema_3_0_0_demo.sh

@ -4,7 +4,6 @@
# md_toc_asciinema_3_0_0_demo.sh
#
# Copyright (C) 2019 frnmst (Franco Masotti) <franco.masotti@live.com>
# <franco.masotti@student.unife.it>
#
# This file is part of md-toc.
#

1
asciinema/md_toc_asciinema_3_1_0_demo.sh

@ -4,7 +4,6 @@
# md_toc_asciinema_3_1_0_demo.sh
#
# Copyright (C) 2019 frnmst (Franco Masotti) <franco.masotti@live.com>
# <franco.masotti@student.unife.it>
#
# This file is part of md-toc.
#

3
asciinema/md_toc_asciinema_5_0_0_demo.sh

@ -1,10 +1,9 @@
#!/bin/bash
#
# md_toc_asciinema_3_1_0_demo.sh
# md_toc_asciinema_5_0_0_demo.sh
#
# Copyright (C) 2019 frnmst (Franco Masotti) <franco.masotti@live.com>
# <franco.masotti@student.unife.it>
#
# This file is part of md-toc.
#

43
asciinema/md_toc_asciinema_6_0_0.json

@ -0,0 +1,43 @@
{"version": 2, "width": 83, "height": 46, "timestamp": 1560350339, "env": {"SHELL": "/bin/bash", "TERM": "rxvt-unicode-256color"}}
[0.012098, "o", "Running a demo to show some of python -m md_toc's capabilities...\r\n\r\n"]
[1.013844, "o", "$ python -m md_toc -h\r\n"]
[1.202271, "o", "usage: __main__.py [-h] [-c | -i] [-l] [-m TOC_MARKER] [-p] [-s SKIP_LINES]\r\n [-v]\r\n [FILE_NAME [FILE_NAME ...]]\r\n {github,cmark,gitlab,commonmarker,redcarpet} ...\r\n\r\nMarkdown Table Of Contents: Automatically generate a compliant table\r\nof contents for a markdown file to improve document readability.\r\n\r\npositional arguments:\r\n FILE_NAME the I/O file name\r\n\r\noptional arguments:\r\n -h, --help show this help message and exit\r\n -c, --no-list-coherence\r\n avoids checking for TOC list coherence\r\n -i, --no-indentation avoids adding indentations to the TOC\r\n -l, --no-links avoids adding links to the TOC\r\n -m TOC_MARKER, --toc-marker TOC_MARKER\r\n set the string to be used as the marker for\r\n positioning the table of contents. Defaults to <!--\r\n TOC-->\r\n -p, --in-place overwrite the input file\r\n -s SKIP_LINES, --skip-lines SKIP_LINE"]
[1.202757, "o", "S\r\n skip parsing of the first selected number of lines.\r\n Defaults to 0, i.e. do not skip any lines\r\n -v, --version show program's version number and exit\r\n\r\nmarkdown parser:\r\n {github,cmark,gitlab,commonmarker,redcarpet}\r\n\r\nPlease read the documentation to understand how each parser works\r\n\r\nReturn values: 0 ok, 1 error, 2 invalid command\r\n\r\nCopyright (C) 2018-2019 Franco Masotti, frnmst\r\nLicense GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\r\nThis is free software: you are free to change and redistribute it.\r\nThere is NO WARRANTY, to the extent permitted by law.\r\n"]
[1.215144, "o", "\r\n"]
[2.2221, "o", "Inspecting the file...\r\n$ cat foo.md\r\n"]
[2.22298, "o", "# Hi\r\n\r\n<!--TOC-->\r\n\r\nhey\r\n\r\n## How are you? !!!\r\n\r\n## fine, thanks\r\n\r\n### Bye\r\n\r\n## Bye bye\r\n\r\n```python\r\n# This is a code\r\n# fence with comments that might represent ATX-style headings\r\n# if not properly parsed\r\n```\r\n\r\nbye\r\n\r\n# boo\r\n"]
[2.223663, "o", "\r\n"]
[3.224875, "o", "Run with default options...\r\n$ python -m md_toc foo.md github\r\n"]
[3.413952, "o", "- [Hi](#hi)\r\n - [How are you? !!!](#how-are-you-----------)\r\n - [fine, thanks](#fine-thanks)\r\n - [Bye](#bye)\r\n - [Bye bye](#bye-bye)\r\n- [boo](#boo)\r\n"]
[3.426435, "o", "\r\n"]
[4.427878, "o", "Ordered list...\r\n$ python -m md_toc foo.md gitlab -o\r\n"]
[4.61836, "o", "1. [Hi](#hi)\r\n 1. [How are you? !!!](#how-are-you-----------)\r\n 2. [fine, thanks](#fine-thanks)\r\n 1. [Bye](#bye)\r\n 3. [Bye bye](#bye-bye)\r\n2. [boo](#boo)\r\n"]
[4.631221, "o", "\r\n"]
[5.632689, "o", "No links...\r\n$ python -m md_toc -l foo.md github\r\n"]
[5.820955, "o", "- Hi\r\n - How are you? !!!\r\n - fine, thanks\r\n - Bye\r\n - Bye bye\r\n- boo\r\n"]
[5.833366, "o", "\r\n"]
[6.834851, "o", "No links and no indentation...\r\n$ python -m md_toc -l -i foo.md github\r\n"]
[7.017477, "o", "- Hi\r\n- How are you? !!!\r\n- fine, thanks\r\n- Bye\r\n- Bye bye\r\n- boo\r\n"]
[7.030133, "o", "\r\n"]
[8.031626, "o", "Inspecting the non-coherent file...\r\n$ cat foo_noncoherent.md\r\n"]
[8.032911, "o", "# Hi\r\n### boo\r\n"]
[8.033147, "o", "\r\n"]
[9.034898, "o", "Trying to parse a non coherent markdown file will raise an exception...\r\n$ python -m md_toc foo_noncoherent.md github\r\n"]
[9.228868, "o", "Traceback (most recent call last):\r\n File \"/home/vm/md-toc/md_toc/__main__.py\", line 34, in main\r\n result = args.func(args)\r\n File \"/home/vm/md-toc/md_toc/cli.py\", line 63, in write_toc\r\n skip_lines=args.skip_lines)\r\n File \"/home/vm/md-toc/md_toc/api.py\", line 303, in build_multiple_tocs\r\n list_marker, skip_lines))\r\n File \"/home/vm/md-toc/md_toc/api.py\", line 226, in build_toc"]
[9.229464, "o", "\r\n raise TocDoesNotRenderAsCoherentList\r\nmd_toc.exceptions.TocDoesNotRenderAsCoherentList\r\n"]
[9.242013, "o", "\r\n"]
[10.243606, "o", "Try to parse a non coherent markdown file without checking for coherence...\r\n$ python -m md_toc -c foo_noncoherent.md github\r\n"]
[10.428045, "o", "- [Hi](#hi)\r\n - [boo](#boo)\r\n"]
[10.440762, "o", "\r\n"]
[11.442176, "o", "Use stdin, no links and no indentation...\r\n$ cat foo.md | python -m md_toc -l -i cmark -u '*'\r\n"]
[11.634328, "o", "* Hi\r\n* How are you? !!!\r\n* fine, thanks\r\n* Bye\r\n* Bye bye\r\n* boo\r\n"]
[11.64981, "o", "\r\n"]
[12.651345, "o", "Inspecting a file where the first 5 lines need to be skipped...\r\n$ cat foo_skiplines.md\r\n"]
[12.65276, "o", "# I want this line to be a comment\r\n#### And this as well\r\n## And this\r\n###### ByeBye\r\n\r\n# Hi\r\n## How\r\n### Are\r\n## You\r\n# Today ?\r\n"]
[12.653268, "o", "\r\n"]
[13.654713, "o", "Using the skip lines option...\r\n$ python -m md_toc -s 5 foo_skiplines.md github\r\n"]
[13.848681, "o", "- [Hi](#hi)\r\n - [How](#how)\r\n - [Are](#are)\r\n - [You](#you)\r\n- [Today ?](#today-)\r\n"]
[13.860635, "o", "\r\n"]
[14.862582, "o", "Editing the file in-place. As you can see, code fence detection still needs to be implemented for redcarpet...\r\n$ python -m md_toc -p foo.md redcarpet\r\n"]
[15.150645, "o", "$ cat foo.md\r\n"]
[15.151666, "o", "# Hi\r\n\r\n<!--TOC-->\r\n\r\n- [Hi](#hi)\r\n - [How are you? !!!](#how-are-you)\r\n - [fine, thanks](#fine-thanks)\r\n - [Bye](#bye)\r\n - [Bye bye](#bye-bye)\r\n- [This is a code](#this-is-a-code)\r\n- [fence with comments that might represent ATX-style headings](#fence-with-comments-that-might-represent-atx-style-headings)\r\n- [if not properly parsed](#if-not-properly-parsed)\r\n- [boo](#boo)\r\n\r\n<!--TOC-->\r\n\r\nhey\r\n\r\n## How are you? !!!\r\n\r\n## fine, thanks\r\n\r\n### Bye\r\n\r\n## Bye bye\r\n\r\n```python\r\n# This is a code\r\n# fence with comments that might represent ATX-style headings\r\n# if not properly parsed\r\n```\r\n\r\nbye\r\n\r\n# boo\r\n"]

154
asciinema/md_toc_asciinema_6_0_0_demo.sh

@ -0,0 +1,154 @@
#!/bin/bash
#
# python -m md_toc_asciinema_6_0_0_demo.sh
#
# Copyright (C) 2019 frnmst (Franco Masotti) <franco.masotti@live.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 5 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
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"
sleep ${TIMEOUT}
cat <<-EOF > foo.md
# Hi
<!--TOC-->
hey
## How are you? !!!
## fine, thanks
### Bye
## Bye bye
\`\`\`python
# This is a code
# fence with comments that might represent ATX-style headings
# if not properly parsed
\`\`\`
bye
# boo
EOF
cat <<-EOF > foo_noncoherent.md
# Hi
### boo
EOF
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 "Inspecting the file...\n"
printf "$ cat foo.md\n"
cat foo.md
printf "\n"
sleep ${TIMEOUT}
printf "Run with default options...\n"
printf "$ python -m md_toc foo.md github\n"
python -m md_toc foo.md github
printf "\n"
sleep ${TIMEOUT}
printf "Ordered list...\n"
printf "$ python -m md_toc foo.md gitlab -o\n"
python -m md_toc foo.md gitlab -o
printf "\n"
sleep ${TIMEOUT}
printf "No links...\n"
printf "$ python -m md_toc -l foo.md github\n"
python -m md_toc -l foo.md github
printf "\n"
sleep ${TIMEOUT}
printf "No links and no indentation...\n"
printf "$ python -m md_toc -l -i foo.md github\n"
python -m md_toc -l -i foo.md github
printf "\n"
sleep ${TIMEOUT}
printf "Inspecting the non-coherent file...\n"
printf "$ cat foo_noncoherent.md\n"
cat foo_noncoherent.md
printf "\n"
sleep ${TIMEOUT}
printf "Trying to parse a non coherent markdown file will raise an exception...\n"
printf "$ python -m md_toc foo_noncoherent.md github\n"
python -m md_toc foo_noncoherent.md github
printf "\n"
sleep ${TIMEOUT}
printf "Try to parse a non coherent markdown file without checking for coherence...\n"
printf "$ python -m md_toc -c foo_noncoherent.md github\n"
python -m md_toc -c foo_noncoherent.md github
printf "\n"
sleep ${TIMEOUT}
printf "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"
sleep ${TIMEOUT}
printf "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"
sleep ${TIMEOUT}
printf "Using the skip lines option...\n"
printf "$ python -m md_toc -s 5 foo_skiplines.md github\n"
python -m md_toc -s 5 foo_skiplines.md github
printf "\n"
sleep ${TIMEOUT}
printf "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 foo.md redcarpet\n"
python -m md_toc -p foo.md redcarpet
printf "$ cat foo.md\n"
cat foo.md
rm foo.md foo_noncoherent.md foo_skiplines.md

7
docs/contributing.rst

@ -1,6 +1,13 @@
Contributing
============
Talk
----
Suggestions, improvements and discussion:
- https://gitter.im/md-toc/community
Git branches
------------

Loading…
Cancel
Save