Browse Source

Updated new version stuff.

master
Franco Masotti 3 years ago
parent
commit
a7b73f81b0
  1. 4
      README.rst
  2. 24
      asciinema/md_toc_asciinema_3_0_0.json
  3. 4
      docs/conf.py
  4. 6
      packages/aur/PKGBUILD
  5. 4
      setup.py

4
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

24
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 <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"]
[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"]

4
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.

6
packages/aur/PKGBUILD

@ -1,7 +1,7 @@
# Maintainer: Franco Masotti <franco dot masotti at student dot unife dot it>
# Contributor: Franco Masotti <franco dot masotti at student dot unife dot it>
# Maintainer: Franco Masotti <franco dot masotti at live dot com>
# Contributor: Franco Masotti <franco dot masotti at live dot com>
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')

4
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',

Loading…
Cancel
Save