Display files and folders as a nice file tree

Author: rishikanthc

markopolis/data_dantic.py

@@ -75,8 +75,18 @@ class BacklinkList(BaseModel):
     backlinks: List[Backlink]
 
 
+class FileItem(BaseModel):
+    title: str
+    link: str
+
+
+class FolderItem(BaseModel):
+    folder: str
+    members: "list[FileItem | FolderItem]"
+
+
 class MarkdownFileList(BaseModel):
-    files: List[str]
+    files: list[FolderItem]
 
 
 class Raw(BaseModel):

markopolis/fastapp.py

@@ -202,12 +202,6 @@ async def load_page(request: Request):
     toc = F.get_headings("home")
     backlinks = F.get_backlinks("home")
 
-    if isinstance(posts, D.Error):
-        logger.warning(f"Error in posts: {posts.error}")
-        posts = []
-    else:
-        posts = posts.files
-
     if isinstance(content, D.Error):
         logger.error(f"Error in content: {content.error}")
         raise HTTPException(
@@ -257,12 +251,6 @@ async def get_note_html(request: Request, path: str):
         toc = F.get_headings(path)
         backlinks = F.get_backlinks(path)
 
-        if isinstance(posts, D.Error):
-            logger.warning(f"Error in posts: {posts.error}")
-            posts = []
-        else:
-            posts = posts.files
-
         if isinstance(content, D.Error):
             logger.error(f"Error in content: {content.error}")
             raise HTTPException(

markopolis/funcs.py

@@ -31,11 +31,11 @@
 __all__ = ["list_md", "get_metadata", "get_note", "get_headings"]
 
 
-def list_md():
+def list_md() -> MarkdownFileList | Error:
     files, error = list_markdown_files()
 
-    if files is not None:
-        return MarkdownFileList(files=files)
+    if files:
+        return MarkdownFileList(files=[files])  # Ensure this is a list of FolderItems
 
     return Error(error=error)
 

markopolis/md.py

@@ -1,6 +1,7 @@
 import os
 import base64
 import markdown
+import markopolis.data_dantic as D
 from typing import Dict, Optional, Any, Tuple, List
 from .md_extensions import (
     CalloutExtension,
@@ -20,21 +21,72 @@
 MDROOT = settings.md_path
 
 
-def list_markdown_files():
-    if not os.path.exists(MDROOT):
-        return None, f"The directory {MDROOT} does not exist."
+# Parse title from markdown file metadata
+def get_markdown_title(filepath: str) -> str:
+    try:
+        with open(filepath, "r", encoding="utf-8") as f:
+            first_line = f.readline().strip()
+            if first_line.startswith("---"):
+                metadata = ""
+                for line in f:
+                    if line.strip() == "---":
+                        break
+                    metadata += line
+
+                metadata_dict = yaml.safe_load(metadata)
+                if isinstance(metadata_dict, dict) and "title" in metadata_dict:
+                    return metadata_dict["title"]
+    except Exception as e:
+        logger.error(f"Error reading file {filepath}: {e}")
+
+    # Fallback to filename if title metadata is not present
+    return os.path.splitext(os.path.basename(filepath))[0]
 
+
+# Recursively list folders and files
+def list_markdown_files(
+    directory: str = "/", root: str = MDROOT
+) -> Tuple[Optional[D.FolderItem], Optional[str]]:
+    if not os.path.exists(root):
+        return None, f"The directory {root} does not exist."
+
+    folder_item = D.FolderItem(folder=directory, members=[])
+    folders = []
     files = []
-    for root, _, filenames in os.walk(MDROOT):
-        for filename in filenames:
-            if filename.endswith(".md"):
-                # Get the relative path from MDROOT
-                rel_path = os.path.relpath(os.path.join(root, filename), MDROOT)
-                # Remove the .md extension
-                rel_path_without_ext = os.path.splitext(rel_path)[0]
-                files.append(rel_path_without_ext)
-
-    return files, ""
+
+    # Separate folders and markdown files
+    for item in sorted(os.listdir(root)):
+        item_path = os.path.join(root, item)
+        rel_path = os.path.relpath(item_path, MDROOT)
+
+        if os.path.isdir(item_path):
+            # Recurse into subfolder
+            subfolder_item, error = list_markdown_files(directory=item, root=item_path)
+            if error:
+                logger.error(f"Error in subfolder: {error}")
+                continue
+            if (
+                subfolder_item and subfolder_item.members
+            ):  # Only include non-empty folders
+                folders.append(subfolder_item)
+        elif item.endswith(".md"):
+            # It's a markdown file
+            title = get_markdown_title(item_path)
+            link = os.path.splitext(rel_path)[0]  # Remove the .md extension
+            file_item = D.FileItem(title=title, link=link)
+            files.append(file_item)
+
+    # Sort folders and files lexicographically
+    folders = sorted(folders, key=lambda x: x.folder)
+    files = sorted(files, key=lambda x: x.title)
+
+    # Combine sorted folders and files, with folders appearing first
+    folder_item.members = folders + files
+
+    if not folder_item.members:
+        return None, None  # Return None for empty folders
+
+    return folder_item, None
 
 
 def clean_filename(filename):

markopolis/md/Markdown-Syntax.md

@@ -0,0 +1,212 @@
+---
+publish: true
+tags:
+  - syntax
+  - markdown
+---
+
+# Headings
+
+```markdown
+# Heading 1
+## Heading 2
+### Heading 3
+#### Heading 4
+##### Heading 5
+```
+
+
+# Heading 1
+## Heading 2
+### Heading 3
+#### Heading 4
+##### Heading 5
+
+## Horizontal line
+
+---
+
+## Images
+
+### embed images
+Image names should be unique. Duplicate images will be overwritten.
+
+```markdown
+![[image.png]]
+```
+
+![[image.png]]
+
+### external images
+
+```markdown
+![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)
+```
+
+![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)
+
+## Wikilinks
+
+```markdown
+[[Installation]]
+[[f1/test]]
+[[f2/test]]
+```
+
+[[Installation]]
+[[f1/test]]
+[[f2/test]]
+
+## Text formatting
+```
+**Bold text**
+*Italic text*
+~~this puts a strikethrough~~
+==this highlights text==
+**Bold text and _nested italic_ text**
+***Bold and italic text***
+```
+
+**Bold text**
+*Italic text*
+~~this puts a strikethrough~~
+==this highlights text==
+**Bold text and _nested italic_ text**
+***Bold and italic text***
+
+## Footnotes
+
+```markdown
+This is a simple footnote[^1].
+
+
+[^1]: This is the referenced text.
+[^2]: Add 2 spaces at the start of each new line.
+  This lets you write footnotes that span multiple lines.
+[^note]: Named footnotes still appear as numbers, but can make it easier to identify and link references.
+```
+
+This is a simple footnote[^1].
+
+
+## Quotes
+
+```markdown
+> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.
+
+\- Doug Engelbart, 1961
+```
+
+> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.
+
+\- Doug Engelbart, 1961
+
+## Tables
+
+```
+| First name | Last name |
+| ---------- | --------- |
+| Max        | Planck    |
+| Marie      | Curie     |
+```
+
+| First name | Last name |
+| ---------- | --------- |
+| Max        | Planck    |
+| Marie      | Curie     |
+
+The vertical bars on either side of the table are optional.
+
+Cells don't need to be perfectly aligned with the columns. Each header row must have at least two hyphens.
+
+```markdown
+First name | Last name
+-- | --
+Max | Planck
+Marie | Curie
+```
+
+First name | Last name
+-- | --
+Max | Planck
+Marie | Curie
+
+## Mermaid diagrams
+
+Some text.
+
+```mermaid
+graph TB
+A --> B
+B --> C
+```
+
+```mermaid
+flowchart LR
+
+
+
+A[Osaka 7-8] --> B[Tokyo 9-11]
+B -.Nagano .-> C[Matsumoto]
+C -.Nagano & Toyama.-> D[Takayama 12] <--> D1(Hida no Sato village)
+B -.Nagano & Toyama.-> D
+C <-.bus.-> D
+D --Toyama---> E <--> D2([Onsen 14]) --> F
+E[Kanazawa 13] ---> F[Kyoto 15-18] <--> F2(Uji) <--> F1(Nara)
+F <-.-> F4(Himeji)
+```
+
+## Callouts
+
+> [!abstract]
+> Lorem ipsum dolor sit amet
+
+> [!info]
+> Lorem ipsum dolor sit amet
+
+> [!todo]
+> Lorem ipsum dolor sit amet
+
+> [!tip]
+> Lorem ipsum dolor sit amet
+
+> [!success]
+> Lorem ipsum dolor sit amet
+
+> [!question]
+> Lorem ipsum dolor sit amet
+
+> [!warning]
+> Lorem ipsum dolor sit amet
+
+> [!failure]
+> Lorem ipsum dolor sit amet
+
+> [!danger]
+> Lorem ipsum dolor sit amet
+
+> [!bug]
+> Lorem ipsum dolor sit amet
+
+> [!example]
+> Lorem ipsum dolor sit amet
+
+> [!quote]
+> Lorem ipsum dolor sit amet
+
+> [!tip] Title-only callout
+
+### Foldable callouts
+
+You can make a callout foldable by adding a plus (+) or a minus (-) directly after the type identifier.
+
+A plus sign expands the callout by default, and a minus sign collapses it instead.
+
+> [!faq]-
+> Are callouts foldable?
+> Yes! In a foldable callout, the contents are hidden when the callout is collapsed.
+
+[^1]: This is the referenced text.
+[^2]: Add 2 spaces at the start of each new line.
+  This lets you write footnotes that span multiple lines.
+[^note]: Named footnotes still appear as numbers, but can make it easier to identify and link references.

markopolis/md/f1/test.md

@@ -2,4 +2,6 @@
 publish: true
 ---
 
-Hello world
+Hello world from f1
+
+[[home]]

markopolis/md/f2/test.md

@@ -2,4 +2,4 @@
 publish: true
 ---
 
-Hello World
+Hello World from f2