Add styles & cleanup structure (#114)

* Add styles to quarto outputs * Cleanup folder structure & remove unused assets
rizinorg · Jan 24, 2024 · 8278c9c · 8278c9c
1 parent bbfe684
commit 8278c9c
Show file tree

Hide file tree

Showing 24 changed files with 47 additions and 105 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,5 @@ index.log
 index.tex
 /.quarto/
 /site_libs/
+/index_files/
+/docs/*
diff --git a/.proselint/proselint/config b/.proselint/proselint/config
diff --git a/_layouts/ebook/pdf_footer.html b/_layouts/ebook/pdf_footer.html
diff --git a/_quarto.yml b/_quarto.yml
@@ -17,11 +17,11 @@ book:
       - index.md
       - part: "Introduction"
         chapters:
-         - src/first_steps/overview.md
-         - src/first_steps/getting_rizin.md
-         - src/first_steps/compilation_portability.md
-         - src/first_steps/windows_compilation.md
-         - src/first_steps/compilation_android.md
+         - src/introduction/overview.md
+         - src/introduction/getting_rizin.md
+         - src/introduction/compilation_portability.md
+         - src/introduction/windows_compilation.md
+         - src/introduction/compilation_android.md
 
       - part: "First Steps"
         chapters:
@@ -73,11 +73,13 @@ book:
          - src/search_bytes/backward_search.md
          - src/search_bytes/search_in_assembly.md
          - src/search_bytes/searching_aes_keys.md
+
       - part: "Disassembling"
         chapters:
          - src/disassembling/intro.md
          - src/disassembling/adding_metadata.md
          - src/disassembling/esil.md
+
       - part: "Analysis"
         chapters:
          - src/analysis/intro.md
@@ -89,15 +91,17 @@ book:
          - src/analysis/syscalls.md
          - src/analysis/emulation.md
          - src/analysis/symbols.md
-         - src/signatures/signatures.md
+         - src/analysis/signatures.md
          - src/analysis/graphs.md
          - src/analysis/cpu_platform_profiles.md
+
       - part: "Scripting"
         chapters:
          - src/scripting/intro.md
          - src/scripting/loops.md
          - src/scripting/macros.md
          - src/scripting/rz-pipe.md
+
       - part: "Debugger"
         chapters:
          - src/debugger/intro.md
@@ -110,11 +114,20 @@ book:
          - src/debugger/revdebug.md
          - src/debugger/windows_messages.md
          - src/debugger/apple.md
+
       - part: "Remote Access"
         chapters:
-         - src/debugger/remoting_capabilities.md
-         - src/debugger/remote_gdb.md
-         - src/debugger/windbg.md
+         - src/remote_access/remoting_capabilities.md
+         - src/remote_access/remote_gdb.md
+         - src/remote_access/windbg.md
+
+      # To be reviewed, it has been added to 
+      # this yaml if we ever change this.
+      # 
+      # - part: "Architectures"
+      #   chapters:
+      #    - src/arch/intro.md
+      #    - src/arch/8051.md
 
       - part: "Command Line Tools"
         chapters:
@@ -154,6 +167,7 @@ book:
          - src/plugins/debug.md
          - src/plugins/testing.md
          - src/plugins/rz-pm.md
+
       - part: "Crackmes"
         chapters:
          - src/crackmes/intro.md
@@ -186,15 +200,30 @@ book:
          - src/crackmes/hackthebox/find-the-easy-pass/find-the-validation-routine.md
          - src/crackmes/hackthebox/find-the-easy-pass/fire-up-the-debugger.md
          - src/crackmes/hackthebox/find-the-easy-pass/bonus.md
+
       - part: "Reference Card"
         chapters:
           - src/refcard/intro.md
+
       - part: "Acknowledgments"
         chapters:
-          - src/credits/credits.md
+          - src/acknowledgments/credits.md
 
 format:
   html:
+    highlight-style: github
     theme:
       light: default
       dark: darkly
+
+  epub:
+    highlight-style: github
+    cover-image: cover.jpg
+
+  pdf:
+    highlight-style: github
+    documentclass: book
+    geometry:
+      - top=30mm
+      - left=20mm
+      - heightrounded
diff --git a/book.toml b/book.toml
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -71,9 +71,9 @@
    * [Reverse Debugging](debugger/revdebug.md)
    * [Windows Messages](debugger/windows_messages.md)
    * [macOS/iOS](debugger/apple.md)
-* [Remote Access](debugger/remoting_capabilities.md)
-   * [Remote GDB](debugger/remote_gdb.md)
-   * [Remote WinDbg](debugger/windbg.md)
+* [Remote Access](remote_access/remoting_capabilities.md)
+   * [Remote GDB](remote_access/remote_gdb.md)
+   * [Remote WinDbg](remote_access/windbg.md)
 * [Command Line Tools](tools/intro.md)
    * [Rz-ax](tools/rz-ax/intro.md)
    * [Rz-find](tools/rz-find/intro.md)

diff --git a/src/credits/credits.md → src/acknowledgments/credits.md b/src/credits/credits.md → src/acknowledgments/credits.md
diff --git a/src/analysis/code_analysis.md.snippets b/src/analysis/code_analysis.md.snippets
diff --git a/src/signatures/signatures.md → src/analysis/signatures.md b/src/signatures/signatures.md → src/analysis/signatures.md
diff --git a/src/basic_commands/print_modes.md.snippets b/src/basic_commands/print_modes.md.snippets
diff --git a/src/debugger/revdebug.md b/src/debugger/revdebug.md
@@ -102,4 +102,4 @@ And step back by `aesb`:
 In addition to the native reverse debugging capabilities in rizin, it's also possible to
 use gdb's remote protocol to reverse debug a target gdbserver that supports it.
 `R!dsb` and `R!dcb` are available as `dsb` and `dcb` replacements for this purpose,
-see [remote gdb's documentation](remote_gdb.md) for more information.
+see [remote gdb's documentation](../remote_access/remote_gdb.md) for more information.
diff --git a/src/img b/src/img
diff --git a/src/img-white/configuration/e--color.png b/src/img-white/configuration/e--color.png
diff --git a/src/first_steps/compilation_android.md → src/introduction/compilation_android.md b/src/first_steps/compilation_android.md → src/introduction/compilation_android.md
diff --git a/src/first_steps/compilation_portability.md → src/introduction/compilation_portability.md b/src/first_steps/compilation_portability.md → src/introduction/compilation_portability.md
diff --git a/src/first_steps/getting_rizin.md → src/introduction/getting_rizin.md b/src/first_steps/getting_rizin.md → src/introduction/getting_rizin.md
diff --git a/src/first_steps/overview.md → src/introduction/overview.md b/src/first_steps/overview.md → src/introduction/overview.md
diff --git a/src/first_steps/windows_compilation.md → src/introduction/windows_compilation.md b/src/first_steps/windows_compilation.md → src/introduction/windows_compilation.md
diff --git a/src/debugger/remote_gdb.md → src/remote_access/remote_gdb.md b/src/debugger/remote_gdb.md → src/remote_access/remote_gdb.md
diff --git a/src/debugger/remoting_capabilities.md → src/remote_access/remoting_capabilities.md b/src/debugger/remoting_capabilities.md → src/remote_access/remoting_capabilities.md
diff --git a/src/debugger/windbg.md → src/remote_access/windbg.md b/src/debugger/windbg.md → src/remote_access/windbg.md
diff --git a/src/pics/after.png → src/visual_mode/assembler_after.png b/src/pics/after.png → src/visual_mode/assembler_after.png
diff --git a/src/pics/before.png → src/visual_mode/assembler_before.png b/src/pics/before.png → src/visual_mode/assembler_before.png
diff --git a/src/visual_mode/visual_assembler.md b/src/visual_mode/visual_assembler.md
@@ -4,13 +4,13 @@ You can use Visual Mode to assemble code (patch) using `A`.
 For example, let's `xor` the EAX register instead of EBP register, here.
 To assemble, seek to the location you want to patch and press `A`.
 
-![Before](../pics/before.png)
+![Before](assembler_before.png)
 
 Notice the preview of the disassembly and arrows. After assembling the instruction,
 you can see that the branch reference lines have been changed, and it is now pointing to 
 the offset of the newly assembled `jne` instruction:
 
-![After](../pics/after.png)
+![After](assembler_after.png)
 
 You need to open the file in writing mode (`rizin -w` or `oo+`) in order to patch the file.
 You can also use the cache mode: `e io.cache=true` and `wc?`.