From 13ace4a5c76596a98f7d5d7a48ac0a3570209c9f Mon Sep 17 00:00:00 2001 From: Aarni Koskela Date: Tue, 24 Apr 2018 13:30:17 +0300 Subject: [PATCH] Configure mkdocs with mkdocs-material and friends --- .gitignore | 3 +++ docs/.pages | 6 ++++++ docs/deploy/.pages | 1 + mkdocs.yml | 24 ++++++++++++++++++++++++ requirements-docs.txt | 5 +++++ 5 files changed, 39 insertions(+) create mode 100644 docs/.pages create mode 100644 docs/deploy/.pages create mode 100644 mkdocs.yml create mode 100644 requirements-docs.txt diff --git a/.gitignore b/.gitignore index a421505ce..fd8e1aeed 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,6 @@ e2e-tests coverage.txt test/e2e/e2e\.test + +# mkdocs +/site \ No newline at end of file diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 000000000..09be52c1b --- /dev/null +++ b/docs/.pages @@ -0,0 +1,6 @@ +arrange: +- index.md +- deploy +- user-guide +- examples +- ... \ No newline at end of file diff --git a/docs/deploy/.pages b/docs/deploy/.pages new file mode 100644 index 000000000..e6ef2d1a5 --- /dev/null +++ b/docs/deploy/.pages @@ -0,0 +1 @@ +title: Deployment \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..7b83ffcc6 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 000000000..0d2bfd4c8 --- /dev/null +++ b/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 \ No newline at end of file