Use material docs theme which has offline support. Closes #118.

yWorks · Mar 18, 2023 · f697991 · f697991
1 parent 1f7f317
commit f697991
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -15,7 +15,7 @@ jobs:
           python-version: '3.x'
       - name: Install and Build
         run: |
-          pip3 install mkdocs
+          pip3 install mkdocs mkdocs-material
           mkdocs build
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@releases/v3

diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ The `assembleBundleDist` task comes with a optional parameter to copy documentat
 In order to build the documentation you will need [mkdocs](https://www.mkdocs.org/):
 
 ```
-pip3 install mkdocs # or use a virtual environment if you prefer
+pip3 install mkdocs mkdocs-material # or use a virtual environment if you prefer
 mkdocs build
 ``` 
 

diff --git a/docs/img/yguard-logo.svg b/docs/img/yguard-logo.svg
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,7 +1,10 @@
 site_name: yGuard Documentation
-theme: readthedocs
 repo_url: https://github.com/yWorks/yGuard/
 site_description: The open-source Java obfuscation tool working with Ant and Gradle by yWorks - the diagramming experts
-use_directory_urls: false
-extra_css:
-  - stylesheets/extra.css
+theme:
+  name: material
+  logo: img/yguard-logo.svg
+  favicon: img/favicon.ico
+plugins:
+  - offline
+  - search