From a7b73f81b00199852f4be64d89516460e43aaa9a Mon Sep 17 00:00:00 2001 From: Franco Masotti Date: Mon, 18 Mar 2019 11:54:39 +0100 Subject: [PATCH] Updated new version stuff. --- README.rst | 4 ++-- asciinema/md_toc_asciinema_3_0_0.json | 24 ++++++++++++++++++++++++ docs/conf.py | 4 ++-- packages/aur/PKGBUILD | 6 +++--- setup.py | 4 ++-- 5 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 asciinema/md_toc_asciinema_3_0_0.json diff --git a/README.rst b/README.rst index 6e2625d..8150c61 100644 --- a/README.rst +++ b/README.rst @@ -45,8 +45,8 @@ each one of them. Video ----- -.. image:: https://asciinema.org/a/170574.png - :target: https://asciinema.org/a/170574 +.. image:: https://asciinema.org/a/234434.png + :target: https://asciinema.org/a/234434 :align: center Documentation diff --git a/asciinema/md_toc_asciinema_3_0_0.json b/asciinema/md_toc_asciinema_3_0_0.json new file mode 100644 index 0000000..f318366 --- /dev/null +++ b/asciinema/md_toc_asciinema_3_0_0.json @@ -0,0 +1,24 @@ +{"version": 2, "width": 83, "height": 46, "timestamp": 1552905547, "env": {"SHELL": "/bin/bash", "TERM": "rxvt-unicode-256color"}} +[0.010489, "o", "Running a demo to show some of md_toc's capabilities...\r\n\r\n"] +[2.014595, "o", "$ md_toc -h\r\n"] +[2.191121, "o", "usage: md_toc [-h] [-p] [-l] [-i] [-m TOC_MARKER] [-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 -p, --in-place overwrite the input file\r\n -l, --no-links avoids adding links to the corresponding content\r\n -i, --no-indentation avoids adding indentations to the corresponding\r\n content\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 [](TOC)\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\nReturn values: 0 OK,"] +[2.191225, "o", " 1 Error, 2 Invalid command\r\n\r\nCopyright (C) 2018-2019 Franco Masotti, frnmst\r\nLicense GPLv3+: GNU GPL version 3 or later \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"] +[2.20289, "o", "\r\n"] +[7.20649, "o", "Inspecting the file...\r\n$ cat foo.md\r\n"] +[7.207679, "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"] +[7.20814, "o", "\r\n"] +[12.210146, "o", "Run with default options...\r\n$ md_toc foo.md github\r\n"] +[12.385408, "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"] +[12.396683, "o", "\r\n"] +[17.398421, "o", "Ordered list...\r\n$ md_toc foo.md gitlab -o\r\n"] +[17.575691, "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\n"] +[17.587251, "o", "\r\n"] +[22.589181, "o", "No links...\r\n$ md_toc -l foo.md github\r\n"] +[22.767776, "o", "- Hi\r\n - How are you? !!!\r\n - fine, thanks\r\n - Bye\r\n - Bye bye\r\n"] +[22.779368, "o", "\r\n"] +[27.780919, "o", "No links and no indentation...\r\n$ md_toc -l -i foo.md github\r\n"] +[27.95595, "o", "- Hi\r\n- How are you? !!!\r\n- fine, thanks\r\n- Bye\r\n- Bye bye\r\n"] +[27.967396, "o", "\r\n"] +[32.969054, "o", "Editing the file in-place...\r\n$ md_toc -p foo.md redcarpet\r\n"] +[33.160029, "o", "$ cat foo.md\r\n"] +[33.160866, "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\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"] diff --git a/docs/conf.py b/docs/conf.py index 73541a2..73be63e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,9 +57,9 @@ author = 'Franco Masotti' # built documents. # # The short X.Y version. -version = '2.0.1' +version = '3.0.0' # The full version, including alpha/beta/rc tags. -release = '2.0.1' +release = '3.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/packages/aur/PKGBUILD b/packages/aur/PKGBUILD index 39149f2..a620e76 100644 --- a/packages/aur/PKGBUILD +++ b/packages/aur/PKGBUILD @@ -1,7 +1,7 @@ -# Maintainer: Franco Masotti -# Contributor: Franco Masotti +# Maintainer: Franco Masotti +# Contributor: Franco Masotti pkgname=python-md_toc -pkgver=2.0.1 +pkgver=3.0.0 pkgrel=1 pkgdesc="Automatically generate a compliant table of contents for a markdown file to improve document readability" arch=('any') diff --git a/setup.py b/setup.py index 57f8b15..92f4231 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ from setuptools import setup, find_packages setup( name='md_toc', - version='2.0.1', + version='3.0.0', packages=find_packages(exclude=['*tests*']), license='GPL', description='An utility that is able to generate a table of contents for a markdown file.', @@ -33,7 +33,7 @@ setup( '': ['*.txt', '*.rst'], }, author='Franco Masotti', - author_email='franco.masotti@student.unife.it', + author_email='franco.masotti@live.com', keywords='markdown toc', url='https://github.com/frnmst/md-toc', python_requires='>=3',