Updates gen readme script, and screenshot docs

Lissy93 · Feb 25, 2024 · c2cfb5b · c2cfb5b
1 parent 9e27867
commit c2cfb5b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/.github/screenshots/README.md b/.github/screenshots/README.md
@@ -1,4 +1,4 @@
-[<sup>↰ Back to README</sup>](../.github/README.md)
+[<sup>↰ Back to README</sup>](../README.md)
 
 ## Screenshots
 
@@ -7,22 +7,22 @@
 > Licensed under MIT ⓒ [Alicia Sykes](https://aliciasykes.com) 2024
 
 ### Category Page
-![fig 1: Category Page](screenshots/1_category-page.png)
+![fig 1: Category Page](1_category-page.png)
 
 ### Section Page
-![fig 2: Section Page](screenshots/2_section-page.png)
+![fig 2: Section Page](2_section-page.png)
 
 ### Browse Page
-![fig 3: Browse Page](screenshots/3_browse-page.png)
+![fig 3: Browse Page](3_browse-page.png)
 
 ### Search Page
-![fig 4: Search Page](screenshots/4_search-page.png)
+![fig 4: Search Page](4_search-page.png)
 
 ### About Page
-![fig 5: About Page](screenshots/5_about-page.png)
+![fig 5: About Page](5_about-page.png)
 
 ### Section Page(2)
-![fig 6: Section Page2](screenshots/6_section-page2.png)
+![fig 6: Section Page2](6_section-page2.png)
 
 ### Homepage
-![fig 7: Homepage](screenshots/homepage.png)
+![fig 7: Homepage](homepage.png)
diff --git a/lib/awesome-privacy-readme-gen.py b/lib/awesome-privacy-readme-gen.py
@@ -44,15 +44,17 @@ def makeHref(text):
     return re.sub(r'[^\w\s-]', '', text.lower()).replace(" ", "-")
 
 def makeContents():
-    contents = "## Contents\n\n"
+    contents = "<details>\n"
+    contents += "<summary><h2>Contents</h2></summary>\n"
+
     for category in data.get('categories'):
-        contents += f"- **{category.get('name')}**"
+        contents += f"\n- **{category.get('name')}**"
         for section in category.get('sections'):
             contents += (
                 f"\n\t- [{section.get('name')}](#{makeHref(section.get('name'))}) "
                 f"({len(section.get('services') or [])})"
             )
-        contents += "\n"
+    contents += "\n</details>\n\n"
     return contents
 
 def makeAwesomePrivacy():