aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/_layouts/README5
-rw-r--r--docs/_layouts/default.html4
-rw-r--r--docs/_layouts/home.html18
-rw-r--r--docs/img/klipper-logo-small.pngbin0 -> 2531 bytes
-rw-r--r--docs/img/klipper-logo.pngbin0 -> 20952 bytes
-rw-r--r--docs/index.md12
6 files changed, 26 insertions, 13 deletions
diff --git a/docs/_layouts/README b/docs/_layouts/README
new file mode 100644
index 00000000..266b60e4
--- /dev/null
+++ b/docs/_layouts/README
@@ -0,0 +1,5 @@
+This directory defines the https://www.klipper3d.org/ website. The
+site is hosted using "github pages" (which uses Jekyll to
+automatically convert the markdown files in the docs/ directory to
+html). In addition to the files in this directory, the docs/CNAME and
+docs/_config.yml file also control the website generation.
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index 104d1860..d6467044 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -34,7 +34,9 @@
<!-- Navbar at top of page -->
<nav class="navbar navbar-expand-md navbar-light bg-light">
- <a class="navbar-brand" href="/">Klipper</a>
+ <a class="navbar-brand" href="/">
+ <img src="img/klipper-logo-small.png" alt="Klipper">
+ </a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html
new file mode 100644
index 00000000..fe77b462
--- /dev/null
+++ b/docs/_layouts/home.html
@@ -0,0 +1,18 @@
+---
+# This file defines the main https://www.klipper3d.org/ page.
+layout: default
+---
+<p class="text-center">Welcome to the Klipper project!</p>
+
+<p class="text-center"><img src="img/klipper-logo.png"/></p>
+
+<p>Klipper is a 3d-Printer firmware. It combines the power of a general
+purpose computer with one or more micro-controllers. See the
+<a href="/Features.html">features</a> document for more information on why you
+should use Klipper.</p>
+
+<p>To begin using Klipper start by <a href="/Installation.html">installing</a> it.</p>
+
+<p>Klipper is Free Software. Read the <a href="/Overview.html">documentation</a> or
+view
+<a href="https://github.com/KevinOConnor/klipper">the Klipper code on github</a>.</p>
diff --git a/docs/img/klipper-logo-small.png b/docs/img/klipper-logo-small.png
new file mode 100644
index 00000000..471e76aa
--- /dev/null
+++ b/docs/img/klipper-logo-small.png
Binary files differ
diff --git a/docs/img/klipper-logo.png b/docs/img/klipper-logo.png
new file mode 100644
index 00000000..5d5cb42e
--- /dev/null
+++ b/docs/img/klipper-logo.png
Binary files differ
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index da065701..00000000
--- a/docs/index.md
+++ /dev/null
@@ -1,12 +0,0 @@
-Welcome to the Klipper project!
-
-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).