Merge pull request #1193 from onekey-sec/handlers-doc

Added supported handlers to the documentation

Author: qkaiser

.gitignore

@@ -6,6 +6,7 @@ build/
 *.egg-info/
 *.so
 .idea
+.cache
 .coverage*
 /.venv
 unblob.log

docs/extra.css

@@ -17,3 +17,17 @@
   --md-typeset-a-color:         #00FFC8;
   --md-hue: 210;
 }
+
+.to_fit {
+
+  .md-typeset__table {
+    table-layout: auto;
+    width: 100%;
+    margin-left: auto;
+    margin-right: auto;
+
+    table {
+      display: table;
+    }
+  }
+}

docs/formats.md

@@ -50,11 +50,11 @@
     | [`SQUASHFS (V1)`](#squashfs-v1) | FILESYSTEM | :octicons-check-16: |
     | [`SQUASHFS (V2)`](#squashfs-v2) | FILESYSTEM | :octicons-check-16: |
     | [`SQUASHFS (V3)`](#squashfs-v3) | FILESYSTEM | :octicons-check-16: |
-    | [`SQUASHFS (V3 - BROADCOM)`](#squashfs-v3---broadcom) | FILESYSTEM | :octicons-check-16: |
-    | [`SQUASHFS (V3 - DDWRT)`](#squashfs-v3---ddwrt) | FILESYSTEM | :octicons-check-16: |
-    | [`SQUASHFS (V3 - NON-STANDARD)`](#squashfs-v3---non-standard) | FILESYSTEM | :octicons-check-16: |
-    | [`SQUASHFS (V4 - BE)`](#squashfs-v4---be) | FILESYSTEM | :octicons-check-16: |
-    | [`SQUASHFS (V4 - LE)`](#squashfs-v4---le) | FILESYSTEM | :octicons-check-16: |
+    | [`SQUASHFS (V3-BROADCOM)`](#squashfs-v3-broadcom) | FILESYSTEM | :octicons-check-16: |
+    | [`SQUASHFS (V3-DDWRT)`](#squashfs-v3-ddwrt) | FILESYSTEM | :octicons-check-16: |
+    | [`SQUASHFS (V3-NON-STANDARD)`](#squashfs-v3-non-standard) | FILESYSTEM | :octicons-check-16: |
+    | [`SQUASHFS (V4-BE)`](#squashfs-v4-be) | FILESYSTEM | :octicons-check-16: |
+    | [`SQUASHFS (V4-LE)`](#squashfs-v4-le) | FILESYSTEM | :octicons-check-16: |
     | [`STUFFIT SIT`](#stuffit-sit) | ARCHIVE | :octicons-check-16: |
     | [`STUFFIT SIT (V5)`](#stuffit-sit-v5) | ARCHIVE | :octicons-check-16: |
     | [`TAR (USTAR)`](#tar-ustar) | ARCHIVE | :octicons-check-16: |
@@ -878,7 +878,7 @@
 
         - [SquashFS Documentation](https://dr-emann.github.io/squashfs/){ target="_blank" }
         - [SquashFS Wikipedia](https://en.wikipedia.org/wiki/SquashFS){ target="_blank" }
-## SquashFS (v3 - Broadcom)
+## SquashFS (v3-Broadcom)
 
 !!! success "Fully supported"
 
@@ -895,7 +895,7 @@
 
         - [SquashFS Documentation](https://dr-emann.github.io/squashfs/){ target="_blank" }
         - [SquashFS Wikipedia](https://en.wikipedia.org/wiki/SquashFS){ target="_blank" }
-## SquashFS (v3 - DDWRT)
+## SquashFS (v3-DDWRT)
 
 !!! success "Fully supported"
 
@@ -912,7 +912,7 @@
 
         - [SquashFS Documentation](https://dr-emann.github.io/squashfs/){ target="_blank" }
         - [SquashFS Wikipedia](https://en.wikipedia.org/wiki/SquashFS){ target="_blank" }
-## SquashFS (v3 - non-standard)
+## SquashFS (v3-non-standard)
 
 !!! success "Fully supported"
 
@@ -929,7 +929,7 @@
 
         - [SquashFS Documentation](https://dr-emann.github.io/squashfs/){ target="_blank" }
         - [SquashFS Wikipedia](https://en.wikipedia.org/wiki/SquashFS){ target="_blank" }
-## SquashFS (v4 - BE)
+## SquashFS (v4-BE)
 
 !!! success "Fully supported"
 
@@ -946,7 +946,7 @@
 
         - [SquashFS Documentation](https://dr-emann.github.io/squashfs/){ target="_blank" }
         - [SquashFS Wikipedia](https://en.wikipedia.org/wiki/SquashFS){ target="_blank" }
-## SquashFS (v4 - LE)
+## SquashFS (v4-LE)
 
 !!! success "Fully supported"
 

docs/handlers.md

@@ -111,9 +111,10 @@
 
               deadnix
               statix
-
+              libz
               cargo
               rustc
+              just
 
               nodejs # for pyright
             ] ++ unblob.runtimeDeps;

flake.nix

@@ -11,7 +11,7 @@ nav:
   - About: index.md
   - User Guide: guide.md
   - installation.md
-  - Supported Formats: formats.md
+  - formats.md
   - extractors.md
   - development.md
   - API: api.md
@@ -25,13 +25,15 @@ markdown_extensions:
   - pymdownx.magiclink
   - def_list
   - attr_list
+  - md_in_html
   - admonition
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.snippets:
+      base_path: docs
   - pymdownx.tabbed:
       alternate_style: true
   - pymdownx.emoji:

mkdocs.yml

@@ -283,7 +283,7 @@ class SquashFSv3DDWRTHandler(SquashFSv3Handler):
     ]
 
     DOC = HandlerDoc(
-        name="SquashFS (v3 - DDWRT)",
+        name="SquashFS (v3-DDWRT)",
         description="SquashFS version 3 DD-WRT is a variant of the SquashFS v3 format used in DD-WRT firmware. It features a unique magic number and may include specific optimizations for embedded systems.",
         handler_type=HandlerType.FILESYSTEM,
         vendor="DDWRT",
@@ -329,7 +329,7 @@ class SquashFSv3BroadcomHandler(SquashFSv3Handler):
     ]
 
     DOC = HandlerDoc(
-        name="SquashFS (v3 - Broadcom)",
+        name="SquashFS (v3-Broadcom)",
         description="SquashFS version 3 Broadcom is a variant of the SquashFS v3 format used in Broadcom firmware. It features a unique magic number and may include specific optimizations for Broadcom devices.",
         handler_type=HandlerType.FILESYSTEM,
         vendor="Broadcom",
@@ -374,7 +374,7 @@ class SquashFSv3NSHandler(SquashFSv3Handler):
     ]
 
     DOC = HandlerDoc(
-        name="SquashFS (v3 - non-standard)",
+        name="SquashFS (v3-non-standard)",
         description="SquashFS version 3 is a compressed, read-only file system format designed for minimal storage usage. It is widely used in embedded systems and Linux distributions for efficient storage and fast access.",
         handler_type=HandlerType.FILESYSTEM,
         vendor="unknown",
@@ -433,7 +433,7 @@ class SquashFSv4LEHandler(_SquashFSBase):
     HEADER_STRUCT = "squashfs4_super_block_t"
 
     DOC = HandlerDoc(
-        name="SquashFS (v4 - LE)",
+        name="SquashFS (v4-LE)",
         description="SquashFS version 4 is a compressed, read-only file system format designed for minimal storage usage and fast access. It is widely used in embedded systems and Linux distributions for efficient storage management.",
         handler_type=HandlerType.FILESYSTEM,
         vendor=None,
@@ -504,7 +504,7 @@ class SquashFSv4BEHandler(SquashFSv4LEHandler):
     EXTRACTOR = SquashFSv4BEExtractor()
 
     DOC = HandlerDoc(
-        name="SquashFS (v4 - BE)",
+        name="SquashFS (v4-BE)",
         description="SquashFS version 4 is a compressed, read-only file system format designed for minimal storage usage and fast access. It supports both big-endian and little-endian formats and is widely used in embedded systems and Linux distributions.",
         handler_type=HandlerType.FILESYSTEM,
         vendor=None,