Added TOC

GLYPHSETS.md

@@ -1,6 +1,16 @@
-## GF_Latin_Kernel
+###Table of Conents:
 
-GF_Latin_Kernel is defined as:
+
+* [GF Latin Kernel](#gf_latin_kernel)
+* [GF Latin Core](#gf_latin_core)
+* [GF Latin African](#gf_latin_african)
+* [GF Arabic Core](#gf_arabic_core)
+* [GF Arabic Plus](#gf_arabic_plus)
+
+
+## GF Latin Kernel
+
+GF_Latin_Kernel is **manually** defined as:
 
 * Script: Latin
 
@@ -9,19 +19,19 @@ GF_Latin_Kernel is defined as:
 The resulting glyphset can be found here: [GF_Latin_Kernel.nam](/Lib/glyphsets/definitions/nam/GF_Latin_Kernel.nam)
 
 
-## GF_Latin_Core
+## GF Latin Core
 
-GF_Latin_Core is defined as:
+GF_Latin_Core is **manually** defined as:
 
 * Script: Latin
-* Manually defined languages: ca_Latn, cs_Latn, cy_Latn, da_Latn, de_Latn, en_Latn, es_Latn, fi_Latn, fr_Latn, hr_Latn, hu_Latn, is_Latn, it_Latn, lt_Latn, lv_Latn, mt_Latn, nb_Latn, nl_Latn, pl_Latn, pt_Latn, ro_Latn, sk_Latn, sq_Latn, sr_Latn, sv_Latn, tr_Latn
+* List of languages: ca_Latn, cs_Latn, cy_Latn, da_Latn, de_Latn, en_Latn, es_Latn, fi_Latn, fr_Latn, hr_Latn, hu_Latn, is_Latn, it_Latn, lt_Latn, lv_Latn, mt_Latn, nb_Latn, nl_Latn, pl_Latn, pt_Latn, ro_Latn, sk_Latn, sq_Latn, sr_Latn, sv_Latn, tr_Latn
 
 The resulting glyphset can be found here: [GF_Latin_Core.nam](/Lib/glyphsets/definitions/nam/GF_Latin_Core.nam)
 
 
-## GF_Latin_African
+## GF Latin African
 
-GF_Latin_African is defined in code as:
+GF_Latin_African is defined **in code** as:
 
 * Script: Latin
 * All languages of the countries AO, BF, BI, BJ, BW, CD, CF, CG, CI, CM, CV, DJ, DZ, EA, EG, EH, ER, ET, GA, GH, GM, GN, GQ, GW, IC, IO, KE, KM, LR, LS, LY, MA, MG, ML, MR, MU, MW, MZ, NA, NE, NG, RE, RW, SC, SD, SH, SL, SN, SO, SS, ST, SZ, TD, TF, TG, TN, TZ, UG, YT, ZA, ZM, ZW
@@ -36,22 +46,22 @@ mua_Latn, vid_Latn, bqv_Latn, lia_Latn, ijs_Latn, kln_Latn, ruf_Latn, ng_Latn, g
 The resulting glyphset can be found here: [GF_Latin_African.nam](/Lib/glyphsets/definitions/nam/GF_Latin_African.nam)
 
 
-## GF_Arabic_Core
+## GF Arabic Core
 
-GF_Arabic_Core is defined as:
+GF_Arabic_Core is **manually** defined as:
 
 * Script: Arabic
-* Manually defined languages: ar_Arab, fa_Arab, ur_Arab
+* List of languages: ar_Arab, fa_Arab, ur_Arab
 
 The resulting glyphset can be found here: [GF_Arabic_Core.nam](/Lib/glyphsets/definitions/nam/GF_Arabic_Core.nam)
 
 
-## GF_Arabic_Plus
+## GF Arabic Plus
 
-GF_Arabic_Plus is defined as:
+GF_Arabic_Plus is **manually** defined as:
 
 * Script: Arabic
-* Manually defined languages: ckb_Arab, ms_Arab, ps_Arab, ps_Arab, ug_Arab
+* List of languages: ckb_Arab, ms_Arab, ps_Arab, ps_Arab, ug_Arab
 
 The resulting glyphset can be found here: [GF_Arabic_Plus.nam](/Lib/glyphsets/definitions/nam/GF_Arabic_Plus.nam)
 

Lib/glyphsets/definitions/__init__.py

@@ -120,11 +120,11 @@ def description_per_glyphset(glyphset_name):
 
     md = ""
 
-    md += f"## {glyphset_name}\n\n"
+    md += f"## {glyphset_name.replace('_', ' ')}\n\n"
     if regions:
-        md += f"{glyphset_name} is defined in code as:\n\n"
+        md += f"{glyphset_name} is defined **in code** as:\n\n"
     else:
-        md += f"{glyphset_name} is defined as:\n\n"
+        md += f"{glyphset_name} is **manually** defined as:\n\n"
     md += f"* Script: {script}\n"
     if regions:
         md += f"* All languages of the countries {', '.join(regions)}\n"
@@ -136,9 +136,9 @@ def description_per_glyphset(glyphset_name):
         md += "* Including auxiliary characters\n"
 
     if regions and language_codes:
-        md += f"* Additionally, the following languages are defined manually: {language_codes}\n"
+        md += f"* Additionally, the following languages are defined **manually**: {language_codes}\n"
     elif not regions and language_codes:
-        md += f"* Manually defined languages: {', '.join(language_codes)}\n"
+        md += f"* List of languages: {', '.join(language_codes)}\n"
     elif not regions and not language_codes:
         md += "\n🛑 Since this glyphset has no defined languages, it can't be checked via Fontbakery's shape_languages check. Please add language code definions here.\n"
 

scripts/assemble_description.py

@@ -28,6 +28,15 @@
 
     md = []
 
+    # TOC
+    md.append("###Table of Conents:\n\n")
+
+    for glyphset_name in glyphset_definitions:
+        md.append(f"* [{glyphset_name.replace('_', ' ')}](#{glyphset_name.lower()})")
+
+    md.append("\n")
+
+    # Content
     for glyphset_name in glyphset_definitions:
         md.append(description_per_glyphset(glyphset_name))