Update docs

WyattBlue · Dec 31, 2024 · 0b48dab · 0b48dab
1 parent ece4fd2
commit 0b48dab
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -11,6 +11,7 @@
 make compile
 
 # Run local
+python build.py 
 make
 
 # Publish
@@ -38,4 +39,4 @@ ExecStart=/root/.bun/bin/bun run server.js
 
 [Install]
 WantedBy=multi-user.target
-```
+```
diff --git a/docs/build.py b/docs/build.py
@@ -2,6 +2,7 @@
 
 import os
 import sys
+from html import escape
 
 # Put 'auto_editor' in Python path
 sys.path.append(os.path.dirname(os.path.dirname(__file__)))
@@ -19,20 +20,26 @@ def main():
 
     with open("src/ref/options.html", "w") as file:
         file.write(
-            '{{ header-desc "Options" "These are the options and flags that auto-editor uses." }}\n'
+            '{{ headerdesc "Options" "These are the options and flags that auto-editor uses." }}\n'
             "<body>\n"
             "{{ nav }}\n"
             '<section class="section">\n'
             '<div class="container">\n'
         )
         for op in parser.args:
             if isinstance(op, OptionText):
-                file.write(f"<h2>{op.text}</h2>\n")
+                file.write(f"<h2>{escape(op.text)}</h2>\n")
             else:
-                file.write(f"<h3><code>{op.names[0]}</code></h3>\n")
+                if op.metavar is None:
+                    file.write(f"<h3><code>{op.names[0]}</code></h3>\n")
+                else:
+                    file.write(
+                        f"<h3><code>{op.names[0]} {escape(op.metavar)}</code></h3>\n"
+                    )
+
                 if len(op.names) > 1:
                     file.write(
-                        "<h4><code>"
+                        "<h4>Aliases: <code>"
                         + "</code> <code>".join(op.names[1:])
                         + "</code></h4>\n"
                     )

diff --git a/docs/components/header-desc.html → docs/components/headerdesc.html b/docs/components/header-desc.html → docs/components/headerdesc.html