From 214c3586d707e32c5f24b93c22858ba98f6ef0eb Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Mon, 27 Apr 2020 13:46:42 +0200 Subject: [PATCH] prettify mkdocs page --- docs/index.md | 6 +++--- mkdocs.yml | 26 ++++++++++++++++++++++++-- 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index d2e9bf05..24cd9500 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,8 @@ -# k3d +# rancher/k3d -k3d is a lightweight wrapper to run k3s (Rancher Lab's minimal Kubernetes distribution) in docker. +k3d is a lightweight wrapper to run [k3s](https://github.com/rancher/k3s) (Rancher Lab's minimal Kubernetes distribution) in docker. -k3d makes it very easy to create single- and multi-node k3s clusters in docker, e.g. for local development on Kubernetes. +k3d makes it very easy to create single- and multi-node [k3s](https://github.com/rancher/k3s) clusters in docker, e.g. for local development on Kubernetes. ## Quick Start diff --git a/mkdocs.yml b/mkdocs.yml index 91d9dea2..80266936 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,12 +6,18 @@ site_url: https://k3d.io/ copyright: "Copyright © 2020 k3d Authors" # Repo Information +repo_name: rancher/k3d repo_url: https://github.com/rancher/k3d -strict: True # Theme theme: name: material + language: en + feature: + tabs: true + palette: + primary: "black" + accent: "grey" # Navigation nav: @@ -23,4 +29,20 @@ nav: # Extensions markdown_extensions: - - codehilite + - toc: + permalink: true + - admonition # https://squidfunk.github.io/mkdocs-material/extensions/admonition/ + - codehilite # https://squidfunk.github.io/mkdocs-material/extensions/codehilite/ + - pymdownx.inlinehilite # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#inlinehilite + - pymdownx.superfences # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#superfences + - pymdownx.tabbed # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#tabbed + - smarty # https://python-markdown.github.io/extensions/smarty/ + +# Plugins +plugins: + - search + - git-revision-date-localized: # https://squidfunk.github.io/mkdocs-material/plugins/revision-date/ + type: date + +# Other Settings +strict: true # halt processing when a warning is raised \ No newline at end of file