docs: add jekyll config (#72)

Author: cmdoret

.gitattributes

@@ -20,17 +20,6 @@
 # Default attribute patterns for common binary files
 # which should be stored in Git LFS.
 # ==================================================
-# Images
-*.[Ii][Cc][Oo] filter=lfs diff=lfs merge=lfs -text
-*.[Jj][Pp][Gg] filter=lfs diff=lfs merge=lfs -text
-*.[Jj][Pp][Ee][Gg] filter=lfs diff=lfs merge=lfs -text
-*.[Pp][Nn][Gg] filter=lfs diff=lfs merge=lfs -text
-*.[Gg][Ii][Ff] filter=lfs diff=lfs merge=lfs -text
-*.[Tt][Ii][Ff] filter=lfs diff=lfs merge=lfs -text
-*.[Tt][Ii][Ff][Ff] filter=lfs diff=lfs merge=lfs -text
-*.[Pp][Ss][Dd] filter=lfs diff=lfs merge=lfs -text
-*.[Aa][Ii] filter=lfs diff=lfs merge=lfs -text
-
 # Media
 *.[Pp][Dd][Ff] filter=lfs diff=lfs merge=lfs -text
 

README.md

@@ -34,19 +34,7 @@ The tool works in two steps:
    graph via a human-readable configuration file and the previously generated
    index
 
-<details>
-    <summary>Table of Content</summary>
-
-<!--toc:start-->
-
-- [Installation](#installation)
-  - [Container](#container)
-  - [Source Build](#source-build)
-- [Usage](#usage)
-- [Development](#development)
-<!--toc:end-->
-
-</details>
+![tripsu flowchart](./docs/assets/diagram/diagram.png)
 
 ## Installation
 

_config.yml

@@ -0,0 +1,7 @@
+remote_theme: pages-themes/cayman@v0.2.0
+title: tripsu
+description: Pseudonymize specific triples in a knowledge graph, with speed and accuracy. 🥷
+markdown: GFM
+plugins:
+  - jemoji
+  - jekyll-remote-theme

docs/assets/diagram/diagram.mmd

@@ -0,0 +1,20 @@
+---
+config:
+  theme: redux
+  look: handDrawn
+  layout: elk
+---
+flowchart LR
+ subgraph subGraph0["Step 1: Indexing"]
+        C["index.json"]
+        B(["index"])
+  end
+ subgraph subGraph1["Step 2: Pseudonymization"]
+        F["pseudo.nt"]
+        D(["pseudo"])
+  end
+    A["input.nt"] --> B & D
+    B --> C
+    C --> D
+    E["rules.yaml"] --> D
+    D --> F