Configure mkdocs with mkdocs-material and friends

.gitignore

@@ -33,3 +33,6 @@ e2e-tests
 
 coverage.txt
 test/e2e/e2e\.test
+
+# mkdocs
+/site

docs/.pages

@@ -0,0 +1,6 @@
+arrange:
+- index.md
+- deploy
+- user-guide
+- examples
+- ...

docs/deploy/.pages

@@ -0,0 +1 @@
+title: Deployment

mkdocs.yml

@@ -0,0 +1,24 @@
+site_name: NGINX Ingress Controller
+strict: true
+repo_name: 'kubernetes/ingress-nginx'
+repo_url: 'https://github.com/kubernetes/ingress-nginx'
+markdown_extensions:
+  - admonition
+  - codehilite
+  - pymdownx.inlinehilite
+  - pymdownx.tasklist(custom_checkbox=true)
+  - toc:
+      permalink: true
+theme:
+  name: material
+  feature:
+    tabs: true
+  logo:
+    icon: 'public'   # globe icon
+  palette:
+    primary: 'teal'
+    accent: 'green'
+plugins:
+  - search
+  - awesome-pages:
+      collapse_single_pages: true

requirements-docs.txt

@@ -0,0 +1,5 @@
+mkdocs-material~=2.7.0
+mkdocs-awesome-pages-plugin~=1.2.0
+mkdocs~=0.17.0
+pygments~=2.2.0
+pymdown-extensions~=4.10