Add ToC via vscode

doc/ADMINGUIDE.md

@@ -1,3 +1,15 @@
+
+**Table of contents**
+<!-- TOC depthFrom:1 insertAnchor:true orderedList:true -->
+
+1. [Introduction](#introduction)
+2. [Highlights](#highlights)
+3. [Installation](#installation)
+4. [Usage help](#usage-help)
+
+<!-- /TOC -->
+
+
 # Owner guide
 
 Some of the following commands  are available for admins of a group or set of groups. Check [USERGUIDE.md](USERGUIDE.md) for commands available to all users.

doc/CONFIG.md

@@ -1,3 +1,14 @@
+
+**Table of contents**
+<!-- TOC depthFrom:1 insertAnchor:true orderedList:true -->
+
+1. [Administrator configuration](#administrator-configuration)
+2. [User/chat configuration](#userchat-configuration)
+3. [Donations](#donations)
+
+<!-- /TOC -->
+
+<a id="markdown-administrator-configuration" name="administrator-configuration"></a>
 ### Administrator configuration
 
 - owner: owner of bot
@@ -9,6 +20,7 @@
 - verbosity: log level verbosity
 - url: URL for telegram server bot api entry point
 
+<a id="markdown-userchat-configuration" name="userchat-configuration"></a>
 ### User/chat configuration
 
 - common
@@ -25,7 +37,8 @@
     - silent: makes stampy not to output messages to that chat
     - welcome: outputs the text when a new user joins the chat, replacing "$username" by user name
 
-## Donations
+<a id="markdown-donations" name="donations"></a>
+### Donations
 
 The bot runs on my hardware which involves (HW, power, internet, etc), if
 you wish to collaborate, please, use <https://www.paypal.me/iranzop> for

doc/USERGUIDE.md

@@ -1,6 +1,24 @@
 
+**Table of contents**
+<!-- TOC depthFrom:1 insertAnchor:true orderedList:true -->
+
+1. [User guide](#user-guide)
+    1. [Introduction](#introduction)
+    2. [Extra commands only for admin user](#extra-commands-only-for-admin-user)
+        1. [Configuration](#configuration)
+        2. [Karma](#karma)
+        3. [Auto-karma triggers](#auto-karma-triggers)
+        4. [Alias](#alias)
+        5. [quote](#quote)
+    3. [Donations](#donations)
+
+<!-- /TOC -->
+
+
+<a id="markdown-user-guide" name="user-guide"></a>
 # User guide
 
+<a id="markdown-introduction" name="introduction"></a>
 ## Introduction
 
 After reading [index.md](index.md) that contains more 'how-to-run' information, it might be interesting for you to learn about how to use it.
@@ -44,8 +62,10 @@ Also, as per general usage:
 - `/cn` To get a random Chuck Norris fact
 
 
+<a id="markdown-extra-commands-only-for-admin-user" name="extra-commands-only-for-admin-user"></a>
 ## Extra commands only for admin user
 
+<a id="markdown-configuration" name="configuration"></a>
 ### Configuration
 
 The bot, once token has been used and admin has been set, will store that information in the database, so you can control it from a chat window
@@ -55,10 +75,12 @@ The bot, once token has been used and admin has been set, will store that inform
     - As of this writing (verbosity, url for api, token, sleep timeout, owner, database, run in daemon mode)
 - `/[g|l]config delete var` will delete that variable from configuration.
 
+<a id="markdown-karma" name="karma"></a>
 ### Karma
 
 - `/skarma word=value` will set specified word to the karma value provided.
 
+<a id="markdown-auto-karma-triggers" name="auto-karma-triggers"></a>
 ### Auto-karma triggers
 
 Bot allows to trigger auto-karma events, so when keyword is given, it will trigger an event to increase karma value for other words
@@ -67,6 +89,7 @@ Bot allows to trigger auto-karma events, so when keyword is given, it will trigg
 - `/alias list [word]` Will show current defined autokarma triggers and in case a word is provided will search based on that word
 - `/alias delete key=value` will delete a previously defined auto-karma so no more auto-karma events will be triggered for that pair
 
+<a id="markdown-alias" name="alias"></a>
 ### Alias
 
 Bot allows to setup alias, so when karma is given to a word, it will instead add it to a different one (and report that one)
@@ -83,10 +106,12 @@ Bot allows to setup alias, so when karma is given to a word, it will instead add
 - `/alias list` Will show current defined aliases
 - `/alias delete key` will delete a previously defined alias so each word gets karma on its own
 
+<a id="markdown-quote" name="quote"></a>
 ### quote
 
 - `/quote del id` to remove a specific quote id from database
 
+<a id="markdown-donations" name="donations"></a>
 ## Donations
 
 The bot runs on my hardware which involves (HW, power, internet, etc), if you wish to collaborate, please, use <https://www.paypal.me/iranzop> for your donation.

doc/index.md

@@ -7,6 +7,19 @@
 [![Code Climate](https://codeclimate.com/github/iranzo/stampython/badges/gpa.svg)](https://codeclimate.com/github/iranzo/stampython)
 [![Pypi](http://img.shields.io/pypi/v/stampython.svg)](https://pypi.python.org/pypi/stampython/)
 
+**Table of contents**
+<!-- TOC depthFrom:2 insertAnchor:true orderedList:true -->
+
+1. [Introduction](#introduction)
+2. [Important](#important)
+3. [Notes](#notes)
+4. [Test](#test)
+5. [Donations](#donations)
+
+<!-- /TOC -->
+
+
+<a id="markdown-introduction" name="introduction"></a>
 ## Introduction
 
 Attempt to create a python script that monitors a telegram bot URL and replies to commands for adding/removing karma.
@@ -21,18 +34,22 @@ Configuration variables at [CONFIG.md](CONFIG.md)
 
 Send a "/help" command to <https://telegram.me/redken_bot> to get up-to-date information about commands available
 
+<a id="markdown-important" name="important"></a>
 ## Important
 
 - The bot will need to have access to all of your messages in order to process them
 
+<a id="markdown-notes" name="notes"></a>
 ## Notes
 
 - On first execution it will create database and start filling values
 
+<a id="markdown-test" name="test"></a>
 ## Test
 
 - I've a copy running the name `@redken_bot`. Invite it to your channels if you want to give it a try or click <https://telegram.me/redken_bot>.
 
+<a id="markdown-donations" name="donations"></a>
 ## Donations
 
 The bot runs on my hardware which involves (HW, power, internet, etc), if