From 6c27c6cdb9feff6ded293b3673e8ae66155f6bed Mon Sep 17 00:00:00 2001
From: David Luevano Alvarado <david@luevano.xyz>
Date: Sat, 18 Feb 2023 16:02:07 -0600
Subject: modify build config and add more test packages

---
 README.md | 34 ++++++++++++++++++----------------
 1 file changed, 18 insertions(+), 16 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 79db720..f971860 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ This program uses the base [`markdown` syntax](https://daringfireball.net/projec
 - Meta-Data.
 - Sane Lists.
 - SmartyPants.
-- Table of Contents.
+- Table of Contents. (With defaults as specified [here](https://python-markdown.github.io/extensions/toc/))
 - WikiLinks.
 - [yafg - Yet Another Figure Generator](https://git.sr.ht/~ferruck/yafg)
 - [Markdown Checklist](https://github.com/FND/markdown-checklist)
@@ -137,25 +137,25 @@ fmt:
   list_sep_date: "%B %Y"
 dirs:
   /: # root "dir_path", whatever is sitting directly under "src"
-	cfg:
-	  plt: "page.html"
-	  # the template can be specified instead of just True/False, a default template will used
-	  tags: False
-	  index: True
-	  rss: True
-	  sitemap: True
-	  exclude_dirs: ["articles", "blog"] # optional; list of subdirectories to exclude when parsing the / dir_path
+    cfg:
+      plt: "page.html"
+      # the template can be specified instead of just True/False, a default template will used
+      tags: False
+      index: True
+      rss: True
+      sitemap: True
+      exclude_dirs: ["articles", "blog"] # optional; list of subdirectories to exclude when parsing the / dir_path
 # below are other example "dir_paths", can be named anything, only the / (above) is mandatory
   articles:
     cfg:
-	  plt: "page.html"
-	  tags: True
-	  index: True
-	  rss: True
-	  sitemap: True
+      plt: "page.html"
+      tags: True
+      index: True
+      rss: True
+      sitemap: True
   blog:
     cfg:
-	  # ...
+      # ...
 ...
 ```
 
@@ -178,7 +178,7 @@ sitemap_run_date: # date the program was run, formatted with 'fmt.sitemap_date'
 ...
 ```
 
-You can add any other option/section that you can later use in the Jinja templates via the exposed config object. URL's shouldn't have the trailing slash `/`
+You can add any other option/section that you can later use in the Jinja templates via the exposed config object. URL's shouldn't have the trailing slash `/`.
 
 ## Available Jinja variables
 
@@ -193,6 +193,8 @@ These variables are exposed to use within the templates. The below list is displ
 	- `lang` (`str`): page language, used for the general `html` tag `lang` attribute.
 	- `summary` (`str`): summary of the page, as specified in the `*.md` file.
 	- `content` (`str`): actual content of the page, this is the `html`.
+    - `toc` (`str`): table of contents as taken from `md.toc`.
+    - `toc_tokens` (`list(dict)`): table of contents tokens as taken from `md.toc_tokens`.
 	- `cdatetime` (`datetime.datetime`): creation datetime object of the page.
 	- `cdate` (`method`): method thtat takes the name of the `fmt.FMT` and applies it to the `cdatetime` object.
 	- `cdate_rss` (`str`): formatted `cdatetime` as required by rss.
-- 
cgit v1.2.3-54-g00ecf