From 074c14322d006be03952e533262df5cba121eeff Mon Sep 17 00:00:00 2001 From: andryyy Date: Mon, 1 May 2017 21:34:26 +0200 Subject: [PATCH] Move files, create README --- README.md | 1 + first_steps.md => docs/first_steps.md | 0 {images => docs/images}/logo.svg | 0 index.md => docs/index.md | 0 install.md => docs/install.md | 0 u_and_e.md => docs/u_and_e.md | 0 mkdocs.yml | 25 +++++++++++++++++++++++++ 7 files changed, 26 insertions(+) create mode 100644 README.md rename first_steps.md => docs/first_steps.md (100%) rename {images => docs/images}/logo.svg (100%) rename index.md => docs/index.md (100%) rename install.md => docs/install.md (100%) rename u_and_e.md => docs/u_and_e.md (100%) create mode 100644 mkdocs.yml diff --git a/README.md b/README.md new file mode 100644 index 000000000..e685400ea --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# mailcow dockerized documentation diff --git a/first_steps.md b/docs/first_steps.md similarity index 100% rename from first_steps.md rename to docs/first_steps.md diff --git a/images/logo.svg b/docs/images/logo.svg similarity index 100% rename from images/logo.svg rename to docs/images/logo.svg diff --git a/index.md b/docs/index.md similarity index 100% rename from index.md rename to docs/index.md diff --git a/install.md b/docs/install.md similarity index 100% rename from install.md rename to docs/install.md diff --git a/u_and_e.md b/docs/u_and_e.md similarity index 100% rename from u_and_e.md rename to docs/u_and_e.md diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..3550a0f3c --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,25 @@ +site_name: "mailcow: dockerized" +repo_url: https://github.com/mailcow/mailcow-dockerized-docs +remote_branch: gh-pages +theme: material +extra: + social: + - type: 'github' + link: 'https://github.com/mailcow/mailcow-dockerized' + palette: + primary: 'indigo' + accent: 'yellow' + logo: 'images/logo.svg' + +markdown_extensions: + - admonition + - codehilite(guess_lang=true) + - footnotes + - meta + - toc(permalink=true) + +pages: + - 'This is mailcow': 'index.md' + - 'Installation': 'install.md' + - 'First Steps': 'first_steps.md' + - 'Usage & Examples': 'u_and_e.md'