aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorDamien <damlobster@gmail.com>2021-07-22 00:40:40 +0200
committerKevinOConnor <kevin@koconnor.net>2021-07-27 13:15:25 -0400
commitcff61605fb7260ab60d1abd4e295b71a533869ac (patch)
treef117dd64e85ec18a62c7c4305781fa03d37ed0a9 /docs/index.md
parent7e88f9220c641dd1e7e5b748381bd7ac758bc8d2 (diff)
downloadkutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.gz
kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.xz
kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.zip
docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..4e221914
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,18 @@
+---
+hide:
+ - navigation
+ - toc
+title: Welcome
+---
+
+![](img/klipper-logo.png){ .center-image }
+
+Klipper is a 3d-Printer firmware. It combines the power of a general
+purpose computer with one or more micro-controllers. See the
+[features](Features.md) document for more information on why you
+should use Klipper.
+
+To begin using Klipper start by [installing](Installation.md) it.
+
+Klipper is Free Software. Read the [documentation](Overview.md) or
+view [the Klipper code on github](https://github.com/KevinOConnor/klipper).