Merge pull request iden3#1 from iden3/feature/change-mkdocs-theme

add new theme for docs, and configuration for it

mkdocs/README-MKDOCS.md

@@ -9,6 +9,11 @@ In case you have a rendering problem with the pieces of code, please execute:
 pip install --upgrade mkdocs
 ```
 
+# Install mkdocs-material theme
+```
+pip install mkdocs-material
+```
+
 # Run the webserver
 At the mkdocs directory execute:
 

mkdocs/mkdocs.yml

@@ -1,40 +1,55 @@
 site_name: Circom 2 Documentation
 site_url: http://127.0.0.1:8000
-theme: readthedocs
+theme:
+     name: material
+     palette:
+          primary: blue
+     # logo: assets/logo.png
+     # favicon: images/favicon.png
+     features:
+          - navigation.tabs
+          - navigation.top
+repo_url: https://github.com/iden3/circom
+markdown_extensions:
+     - pymdownx.arithmatex:
+          generic: true
+extra_javascript:
+     - javascripts/mathjax.js
+     - https://polyfill.io/v3/polyfill.min.js?features=es6
+     - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
 
 nav:
-  - Getting started:        
-    - Background on ZK: 'getting-started/background.md'
-    - Installation: 'getting-started/installation.md'
-    - Writing and compiling circuits: 'getting-started/writing-compiling-circuits.md'
-    - Computing the witness: 'getting-started/computing-the-witness.md'
-#     - Testing circuits: 'getting-started/testing-circuits.md'
-    - Proving circuits with ZK: 'getting-started/proving-circuits.md'
-  - The circom Language:
-    - Signals:
-         - Signals: 'circom-language/signals.md'
-         - Variables & Mutability: 'circom-language/variables-and-mutability.md'
-    - Templates:
-         - Templates & Components: 'circom-language/templates-and-components.md'
-         - Pragma: 'circom-language/pragma.md'
-         - Functions: 'circom-language/functions.md'
-         - Include: 'circom-language/include.md'
-         - The main Component: 'circom-language/the-main-component.md'
-    - Syntax:
-         - Comment Lines: 'circom-language/comment-lines.md'
-         - Identifiers: 'circom-language/identifiers.md'
-         - Reserved-keywords: 'circom-language/reserved-keywords.md'
-    - Basic Operators: 'circom-language/basic-operators.md'
-    - Constraint Generation: 'circom-language/constraint-generation.md'
-    - Control Flow: 'circom-language/control-flow.md'
-    - Data Types: 'circom-language/data-types.md'
-    - Scoping: 'circom-language/scoping.md'
-    - Code Quality:
-         - Code Assertion: 'circom-language/code-quality/code-assertion.md'
-         - Debugging Operations: 'circom-language/code-quality/debugging-operations.md'
-    - Circom Insight:
-         - Compiler Phases: 'circom-language/circom-insight/circom-phases.md'
-         - Compiler Messages: 'circom-language/circom-insight/compiler-messages.md'
-         - Unknowns : 'circom-language/circom-insight/unknowns.md'
-         - Circom Library: 'circom-language/circom-insight/circom-library.md'
-
+     - Getting started:
+          - Background on ZK: 'getting-started/background.md'
+          - Installation: 'getting-started/installation.md'
+          - Writing and compiling circuits: 'getting-started/writing-compiling-circuits.md'
+          - Computing the witness: 'getting-started/computing-the-witness.md'
+          # - Testing circuits: 'getting-started/testing-circuits.md'
+          - Proving circuits with ZK: 'getting-started/proving-circuits.md'
+     - The circom Language:
+          - Signals:
+               - Signals: 'circom-language/signals.md'
+               - Variables & Mutability: 'circom-language/variables-and-mutability.md'
+          - Templates:
+               - Templates & Components: 'circom-language/templates-and-components.md'
+               - Pragma: 'circom-language/pragma.md'
+               - Functions: 'circom-language/functions.md'
+               - Include: 'circom-language/include.md'
+               - The main Component: 'circom-language/the-main-component.md'
+          - Syntax:
+               - Comment Lines: 'circom-language/comment-lines.md'
+               - Identifiers: 'circom-language/identifiers.md'
+               - Reserved-keywords: 'circom-language/reserved-keywords.md'
+          - Basic Operators: 'circom-language/basic-operators.md'
+          - Constraint Generation: 'circom-language/constraint-generation.md'
+          - Control Flow: 'circom-language/control-flow.md'
+          - Data Types: 'circom-language/data-types.md'
+          - Scoping: 'circom-language/scoping.md'
+          - Code Quality:
+               - Code Assertion: 'circom-language/code-quality/code-assertion.md'
+               - Debugging Operations: 'circom-language/code-quality/debugging-operations.md'
+          - Circom Insight:
+               - Compiler Phases: 'circom-language/circom-insight/circom-phases.md'
+               - Compiler Messages: 'circom-language/circom-insight/compiler-messages.md'
+               - Unknowns : 'circom-language/circom-insight/unknowns.md'
+               - Circom Library: 'circom-language/circom-insight/circom-library.md'