prettify mkdocs page

pull/212/head
iwilltry42 4 years ago
parent 867dc890a4
commit 214c3586d7
No known key found for this signature in database
GPG Key ID: 7BA57AD1CFF16110
  1. 6
      docs/index.md
  2. 26
      mkdocs.yml

@ -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

@ -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
Loading…
Cancel
Save