aboutsummaryrefslogtreecommitdiffstats
path: root/docs/_klipper3d/README
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_klipper3d/README')
-rw-r--r--docs/_klipper3d/README6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/_klipper3d/README b/docs/_klipper3d/README
new file mode 100644
index 00000000..3f291c88
--- /dev/null
+++ b/docs/_klipper3d/README
@@ -0,0 +1,6 @@
+This directory defines the https://www.klipper3d.org/ website. The
+site is hosted using "github pages". The
+.github/workflows/klipper3d-deploy.yaml tool uses mkdocs (
+https://www.mkdocs.org/ ) to automatically convert the markdown files
+in the docs/ directory to html. In addition to the files in this
+directory, the docs/CNAME file also controls the website generation.