Merge pull request #23 from cryptimeleon/develop

v2.0.0 docu

Author: feidens

.github/workflows/github-pages.yml

@@ -3,7 +3,7 @@ name: Build and deploy Jekyll site to Github Pages
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   github-pages:

Gemfile.lock

@@ -75,7 +75,7 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rouge (3.26.0)
     ruby2_keywords (0.0.4)
     safe_yaml (1.0.5)

README.md

@@ -4,4 +4,4 @@ You can view the rendered page [here](https://cryptimeleon.github.io).
 
 ## How to Build This Site Locally
 
-To render the documentation locally, follow the instructions in our [DEVELOPER.md](https://github.com/cryptimeleon/cryptimeleon.github.io/blob/gh-pages/DEVELOPER.md) file.
+To render the documentation locally, follow the instructions in our [DEVELOPER.md](https://github.com/cryptimeleon/cryptimeleon.github.io/blob/develop/DEVELOPER.md) file.

_config.yml

@@ -6,8 +6,9 @@ relative_links:
     collections: true
 theme: minimal-mistakes-jekyll
 minimal_mistakes_skin: "air"
-title: Cryptimeleon Documentation
-subtitle: "Version 1.0.0"
+title: Cryptimeleon
+subtitle: Prototyping of Cryptographic Construction
+logo: /assets/logo.png
 repository: cryptimeleon/cryptimeleon.github.io
 locale: en
 description: Documentation page for the Cryptimeleon cryptography libraries.
@@ -25,6 +26,9 @@ kramdown:
     auto_ids: true
     hard_wrap: false
 
+cracoversion: 2.0.0
+mathversion: 2.0.0
+
 # exclude from jekyll site
 exclude:
     - vendor
@@ -33,4 +37,4 @@ exclude:
     - Gemfile.lock
     - README.md
     - Dockerfile
-    - LICENSE
+    - LICENSE

_data/navigation.yaml

@@ -1,10 +1,8 @@
 docs:
 - title: Getting Started
   children:
-    - title: "Libraries Overview"
-      url: /getting-started/libraries.html
-    - title: "Installation"
-      url: /getting-started/installation.html
+    - title: "First Steps"
+      url: /getting-started/first-steps.html
     - title: "5-minute Tutorial"
       url: /getting-started/5-minute-tutorial.html
     - title: "Pairing Tutorial"
@@ -15,6 +13,8 @@ docs:
       url: /getting-started/implement-elgamal.html
 - title: Documentation
   children:
+    - title: "How do I ...?"
+      url: /docs/how-do-I.html
     - title: "Lazy Evaluation"
       url: /docs/lazy-eval.html
     - title: "Bilinear Groups"
@@ -23,6 +23,8 @@ docs:
       url: /docs/representations.html
     - title: "Benchmarking"
       url: /docs/benchmarking.html
+    - title: "Group Signatures"
+      url: /docs/groupsig.html
     - title : "Javadocs"
       url: /docs/javadoc.html
     - title: "Frequently Asked Questions"
@@ -35,5 +37,3 @@ docs:
       url: /contributors/composite-builds.html
     - title: "Contributing"
       url: /contributors/contributing.html
-    - title: "Dependencies"
-      url: /contributors/dependencies.html

_includes/head/custom.html

@@ -2,4 +2,12 @@
 <script type="text/javascript" async
   src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML">
 </script>
-{% endif %}
+{% endif %}
+
+<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
+<link rel="manifest" href="/site.webmanifest">
+<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
+<meta name="msapplication-TileColor" content="#da532c">
+<meta name="theme-color" content="#eeeeee">