Merge pull request #492 from onekey-sec/402-improve-unblob-docs

Improved unblob documentation

Author: qkaiser

default.nix

@@ -74,6 +74,7 @@ let
         arpy = overrideWithSetuptools super.arpy { };
         yaffshiv = overrideWithSetuptools super.yaffshiv { };
         ubi-reader = overrideWithSetuptools super.ubi-reader { };
+        cairosvg = overrideWithSetuptools super.cairocffi { };
       });
 
     python = python3;

docs/ArtegraSans-Regular.ttf

@@ -0,0 +1,33 @@
+---
+hide:
+  - navigation
+---
+
+# API Reference
+
+::: unblob.models.Handler
+    handler: python
+    options:
+      members:
+        - get_dependencies
+        - calculate_chunk
+        - extract
+      show_root_heading: true
+      show_source: true
+
+::: unblob.models.StructHandler
+    handler: python
+    options:
+      members:
+        - parse_header
+      show_root_heading: true
+      show_source: true
+
+::: unblob.models.Extractor
+    handler: python
+    options:
+      members:
+        - get_dependencies
+        - extract
+      show_root_heading: true
+      show_source: true

docs/api.md

@@ -1,3 +1,12 @@
+@font-face {
+    font-family: "Artegra Sans";
+    src: url("ArtegraSans-Regular.ttf");
+}
+
+html {
+    font-family: "Artegra Sans", Sans-serif;
+}
+
 [data-md-color-scheme="default"] {
   --md-primary-fg-color:        #002060;
   --md-typeset-a-color:         #008ed5;

docs/extra.css

@@ -96,6 +96,8 @@ unblob identifies known and unknown chunks of data within a file:
   information about identified chunks (format, offsets, size, entropy) and their
   extracted content if available (ownership, permissions, timestamps, ...).
 
+![unblob_architecture.webp](unblob_architecture.webp)
+
 ## Used technologies
 
 - unblob is written in [Python](https://www.python.org/).

docs/index.md

@@ -0,0 +1,16 @@
+# Publications
+
+## Talks
+
+- BlackAlps 2022 - [Firmwares Are Weird. A Year Long Journey To Efficient Extraction (video)](https://www.youtube.com/watch?v=PZ_gw85PcgY)
+- BlackAlps 2022 - [Firmwares Are Weird. A Year Long Journey To Efficient Extraction (PDF)](https://www.blackalps.ch/ba-22/files/talks/BlackAlps22-Kaiser.pdf)
+- Hacktivity Budapest 2022 - [Making Sense of Firmware Images - The Journey to Efficient Extraction (video)](https://www.youtube.com/watch?v=TmmKmhBnf9I)
+
+## Demo & Workshop
+
+- [DEFCON Demo Labs 2022](https://forum.defcon.org/node/242253)
+- [BlackHat USA Arsenal 2022](https://www.blackhat.com/us-22/arsenal/schedule/#unblob-26664)
+
+## Podcasts
+
+- SecTools Podcast - [Episode 41 with ONEKEY Team about Unblob](https://infoseccampus.com/podcast/sectools-e41-onekey-unblob/)

docs/publications.md

@@ -1,6 +1,7 @@
 site_name: unblob - extract everything!
-site_author: OneKey developers
+site_author: ONEKEY developers
 site_description: unblob is an accurate, fast, and easy-to-use extraction suite. unblob parses unknown binary blobs for more than 30 different archive, compression, and file-system formats, extracts their content recursively, and carves out unknown chunks that have not been accounted for. This turns unblob into the perfect companion for extracting, analyzing, and reverse engineering firmware images.
+site_url: https://unblob.org/
 
 repo_name: Unblob on GitHub
 repo_url: https://github.com/onekey-sec/unblob
@@ -13,7 +14,9 @@ nav:
   - Supported Formats: formats.md
   - extractors.md
   - development.md
+  - API: api.md
   - glossary.md
+  - publications.md
   - support.md
 
 markdown_extensions:
@@ -33,7 +36,7 @@ theme:
   logo: logo.svg
   favicon: favicon.png
   font:
-    text: Artegra Sans
+      text: Artegra Sans
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -53,6 +56,15 @@ theme:
 extra_css:
   - extra.css
 
+plugins:
+  - search
+  - mkdocstrings
+  - social:
+      cards: true
+      cards_color:
+        fill: "#002060"
+        text: "#00FFC8"
+
 extra:
   social:
     - icon: fontawesome/brands/github