_klipper3d: Add comments to files in this directory

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-07-27 13:49:06 -04:00
parent 994f388b5c
commit 9c6b4d1bf4
4 changed files with 9 additions and 0 deletions

6
docs/_klipper3d/README Normal file
View File

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

View File

@ -1,3 +1,4 @@
/* Customization of mkdocs generated site */
[data-md-color-scheme="slate"] {
--md-primary-fg-color: hsla(var(--md-hue),15%,12%,1);
--md-default-bg-color: hsla(var(--md-hue),17%,17%,1);

View File

@ -1,3 +1,4 @@
# Python virtualenv module requirements for mkdocs
mkdocs==1.2.2
mkdocs-material==7.2.0
mkdocs-section-index==0.3.1

View File

@ -1,3 +1,4 @@
# Tool to customize conversion of markdown files during mkdocs site generation
import re
import logging