aboutsummaryrefslogtreecommitdiffstats
path: root/docs/_klipper3d/README
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-07-27 13:49:06 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-07-27 13:49:06 -0400
commit9c6b4d1bf4f04bf32544efe6625017a34e30c1c0 (patch)
treefe636b90b0fed58b2b83aef37a0ba523ef05392f /docs/_klipper3d/README
parent994f388b5cbf32013c48c3c561a254a8c11bc7db (diff)
downloadkutter-9c6b4d1bf4f04bf32544efe6625017a34e30c1c0.tar.gz
kutter-9c6b4d1bf4f04bf32544efe6625017a34e30c1c0.tar.xz
kutter-9c6b4d1bf4f04bf32544efe6625017a34e30c1c0.zip
_klipper3d: Add comments to files in this directory
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
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.