diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..c3c9ee0 Binary files /dev/null and b/.DS_Store differ diff --git a/404.html b/404.html index 501d14f..e717050 100644 --- a/404.html +++ b/404.html @@ -12,7 +12,7 @@ - + @@ -42,6 +42,22 @@ + + + + + + + + + + + + + + + + @@ -398,6 +414,8 @@

404 - Not found

+ + \ No newline at end of file diff --git a/config/index.html b/config/index.html index 8ff49f4..5b89fe5 100644 --- a/config/index.html +++ b/config/index.html @@ -18,7 +18,7 @@ - + @@ -48,6 +48,22 @@ + + + + + + + + + + + + + + + + @@ -455,6 +471,20 @@
+ + + + + + + + + + + + + + @@ -534,6 +564,7 @@

Maintenance Sections

+
@@ -572,6 +603,8 @@

Maintenance Sections

+ + \ No newline at end of file diff --git a/css/print-site-enum-headings1.css b/css/print-site-enum-headings1.css new file mode 100644 index 0000000..f767fbb --- /dev/null +++ b/css/print-site-enum-headings1.css @@ -0,0 +1,75 @@ +/* +Enumerate headings + +Only displayed when set in mkdocs.yml + +print-site: + - print-site-enumerate_headings: true +*/ + +/* Reset all enumeration at start of page */ +body {counter-reset: chapter sec-top toc-chapter toc-sec-chapter figurecounter;} + +/* Enumerate headings of CHAPTERS, +that are part of an original included page */ +.print-site-enumerate-headings .print-page h1 {counter-reset: section sub-section composite detail last; } +.print-site-enumerate-headings .print-page h2 {counter-reset: sub-section composite detail last; } +.print-site-enumerate-headings .print-page h3 {counter-reset: composite detail last; } +.print-site-enumerate-headings .print-page h4 {counter-reset: detail last; } +.print-site-enumerate-headings .print-page h5 {counter-reset: last; } +.print-site-enumerate-headings .print-page h1:before { + counter-increment: chapter; + content: counter(chapter) " " !important; +} +.print-site-enumerate-headings h1.print-page-toc-title:before, +#print-site-cover-page h1:before, +#print-site-cover-page h2:before, +#print-site-cover-page h3:before, +#print-site-cover-page h4:before, +#print-site-cover-page h5:before, +#print-site-cover-page h6:before { + content: none !important; + counter-increment: none; +} + + +/* Enumerate headings of SECTIONS, +that are part of an original included page */ +.print-site-enumerate-headings h1 {counter-reset: sec-section sec-sub-section sec-composite sec-detail sec-last; } +.print-site-enumerate-headings h2.nav-section-title {counter-reset: sec-sub-section sec-composite sec-detail sec-last; } +.print-site-enumerate-headings h3.nav-section-title {counter-reset: sec-composite sec-detail sec-last; } +.print-site-enumerate-headings h4.nav-section-title {counter-reset: sec-detail sec-last; } +.print-site-enumerate-headings h5.nav-section-title {counter-reset: sec-last; } +.print-site-enumerate-headings h1.nav-section-title:before { + counter-increment: sec-top; + content: counter(sec-top, upper-roman) ". " !important; +} + + +/* Enumerate CHAPTERS in table of contents also */ +.print-site-enumerate-headings .print-site-toc-level-1 > ul { counter-reset: toc-section; } +.print-site-enumerate-headings .print-site-toc-level-2 > ul { counter-reset: toc-sub-section; } +.print-site-enumerate-headings .print-site-toc-level-3 > ul { counter-reset: toc-composite; } +.print-site-enumerate-headings .print-site-toc-level-4 > ul { counter-reset: toc-detail; } +.print-site-enumerate-headings .print-site-toc-level-5 > ul { counter-reset: toc-last; } +.print-site-enumerate-headings .print-site-toc-level-1 > li a:before { + counter-increment: toc-chapter; + content: counter(toc-chapter) " "; +} + +/* Enumerate SECTIONS in table of contents also */ +.print-site-enumerate-headings li.toc-nav-section-title-level-1 { counter-reset: toc-sec-section; } +.print-site-enumerate-headings li.toc-nav-section-title-level-2 { counter-reset: toc-sec-sub-section; } +.print-site-enumerate-headings li.toc-nav-section-title-level-3 { counter-reset: toc-sec-composite; } +.print-site-enumerate-headings li.toc-nav-section-title-level-4 { counter-reset: toc-sec-detail; } +.print-site-enumerate-headings li.toc-nav-section-title-level-5 { counter-reset: toc-sec-last; } +.print-site-enumerate-headings li.toc-nav-section-title-level-1:before { + counter-increment: toc-sec-chapter; + content: counter(toc-sec-chapter, upper-roman) " "; +} + + +#print-page-toc li a.headerlink:before { + content: none !important; + counter-increment: none; +} diff --git a/css/print-site-enum-headings2.css b/css/print-site-enum-headings2.css new file mode 100644 index 0000000..24b44e0 --- /dev/null +++ b/css/print-site-enum-headings2.css @@ -0,0 +1,46 @@ + +/* +Enumerate level 2 headings of CHAPTERS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + +.print-site-enumerate-headings .print-page h2:before { + counter-increment: section; + content: counter(chapter) "." counter(section) " " !important; +} + +/* +Enumerate level 2 headings of SECTIONS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ +.print-site-enumerate-headings h2.nav-section-title:before { + counter-increment: sec-section; + content: counter(sec-top, upper-roman) "." counter(sec-section, upper-roman) " " !important; + } + + +/* Enumerate CHAPTERS in table of contents also */ + +.print-site-enumerate-headings .print-site-toc-level-2 > li a:before { + counter-increment: toc-section; + content: counter(toc-chapter) "." counter(toc-section) " "; +} + +/* Enumerate SECTIONS in table of contents also */ + +.print-site-enumerate-headings li.toc-nav-section-title-level-2:before { + counter-increment: toc-sec-section; + content: counter(toc-sec-chapter, upper-roman) "." counter(toc-sec-section, upper-roman) " "; +} diff --git a/css/print-site-enum-headings3.css b/css/print-site-enum-headings3.css new file mode 100644 index 0000000..c5059e6 --- /dev/null +++ b/css/print-site-enum-headings3.css @@ -0,0 +1,52 @@ + +/* +Enumerate level 2 headings of CHAPTERS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + + +.print-site-enumerate-headings .print-page h3:before { +counter-increment: sub-section; +content: counter(chapter) "." counter(section) "." counter(sub-section) " " !important; +} + + +/* +Enumerate level 2 headings of SECTIONS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + +.print-site-enumerate-headings h3.nav-section-title:before { + counter-increment: sec-sub-section; + content: counter(sec-top, upper-roman) "." counter(sec-section, upper-roman) "." counter(sec-sub-section, upper-roman) " " !important; +} + + +/* Enumerate CHAPTERS in table of contents also */ + + +.print-site-enumerate-headings .print-site-toc-level-3 > li a:before { + counter-increment: toc-sub-section; + content: counter(toc-chapter) "." counter(toc-section) "." counter(toc-sub-section) " "; +} + + +/* Enumerate SECTIONS in table of contents also */ + + +.print-site-enumerate-headings li.toc-nav-section-title-level-3:before { + counter-increment: toc-sec-sub-section; + content: counter(toc-sec-chapter, upper-roman) "." counter(toc-sec-section, upper-roman) "." counter(toc-sec-sub-section, upper-roman) " "; +} diff --git a/css/print-site-enum-headings4.css b/css/print-site-enum-headings4.css new file mode 100644 index 0000000..5c08e21 --- /dev/null +++ b/css/print-site-enum-headings4.css @@ -0,0 +1,49 @@ + +/* +Enumerate level 2 headings of CHAPTERS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + +.print-site-enumerate-headings .print-page h4:before { +counter-increment: composite; +content: counter(chapter) "." counter(section) "." counter(sub-section) "." counter(composite) " " !important; +} + +/* +Enumerate level 2 headings of SECTIONS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + + +.print-site-enumerate-headings h4.nav-section-title:before { + counter-increment: sec-composite; + content: counter(sec-top, upper-roman) "." counter(sec-section, upper-roman) "." counter(sec-sub-section, upper-roman) "." counter(sec-composite, upper-roman) " " !important; +} + +/* Enumerate CHAPTERS in table of contents also */ + +.print-site-enumerate-headings .print-site-toc-level-4 > li a:before { + counter-increment: toc-composite; + content: counter(toc-chapter) "." counter(toc-section) "." counter(toc-sub-section) "." counter(toc-composite) " "; +} + + +/* Enumerate SECTIONS in table of contents also */ + + +.print-site-enumerate-headings li.toc-nav-section-title-level-4before { + counter-increment: toc-sec-composite; + content: counter(toc-sec-chapter, upper-roman) "." counter(toc-sec-section, upper-roman) "." counter(toc-sec-sub-section, upper-roman) "." counter(toc-sec-composite, upper-roman) " "; +} diff --git a/css/print-site-enum-headings5.css b/css/print-site-enum-headings5.css new file mode 100644 index 0000000..4f11f36 --- /dev/null +++ b/css/print-site-enum-headings5.css @@ -0,0 +1,49 @@ + +/* +Enumerate level 2 headings of CHAPTERS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + +.print-site-enumerate-headings .print-page h5:before { +counter-increment: detail; +content: counter(chapter) "." counter(section) "." counter(sub-section) "." counter(composite) "." counter(detail) " " !important; +} + +/* +Enumerate level 2 headings of SECTIONS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + + +.print-site-enumerate-headings h5.nav-section-title:before { + counter-increment: sec-detail; + content: counter(sec-top, upper-roman) "." counter(sec-section, upper-roman) "." counter(sec-sub-section, upper-roman) "." counter(sec-composite, upper-roman) "." counter(sec-detail, upper-roman) " " !important; +} + + +/* Enumerate CHAPTERS in table of contents also */ + +.print-site-enumerate-headings .print-site-toc-level-5 > li a:before { + counter-increment: toc-detail; + content: counter(toc-chapter) "." counter(toc-section) "." counter(toc-sub-section) "." counter(toc-composite) "." counter(toc-detail) " "; +} + + +/* Enumerate SECTIONS in table of contents also */ + +.print-site-enumerate-headings li.toc-nav-section-title-level-5:before { + counter-increment: toc-detail; + content: counter(toc-sec-chapter, upper-roman) "." counter(toc-sec-section, upper-roman) "." counter(toc-sec-sub-section, upper-roman) "." counter(toc-sec-composite, upper-roman) "." counter(toc-sec-detail, upper-roman) " "; +} diff --git a/css/print-site-enum-headings6.css b/css/print-site-enum-headings6.css new file mode 100644 index 0000000..0bcf682 --- /dev/null +++ b/css/print-site-enum-headings6.css @@ -0,0 +1,49 @@ + +/* +Enumerate level 2 headings of CHAPTERS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + + +.print-site-enumerate-headings .print-page h6:before { + counter-increment: last; + content: counter(chapter) "." counter(section) "." counter(sub-section) "." counter(composite) "." counter(detail) "." counter(last) " " !important; +} + +/* +Enumerate level 2 headings of SECTIONS, +that are part of an original included page + +Only displayed when set in mkdocs.yml: + +print-site: + - enumerate_headings: true + - enumerate_headings_depth: 2 # or more +*/ + +.print-site-enumerate-headings h6.nav-section-title:before { + counter-increment: sec-last; + content: counter(sec-top, upper-roman) "." counter(sec-section, upper-roman) "." counter(sec-sub-section, upper-roman) "." counter(sec-composite, upper-roman) "." counter(sec-detail, upper-roman) "." counter(sec-last, upper-roman) " " !important; +} + + +/* Enumerate CHAPTERS in table of contents also */ + +.print-site-enumerate-headings .print-site-toc-level-6 > li a:before { + counter-increment: toc-last; + content: counter(toc-chapter) "." counter(toc-section) "." counter(toc-sub-section) "." counter(toc-composite) "." counter(toc-detail) "." counter(toc-last) " "; +} + +/* Enumerate SECTIONS in table of contents also */ + +.print-site-enumerate-headings li.toc-nav-section-title-level-6:before { + counter-increment: toc-sec-last; + content: counter(toc-sec-chapter, upper-roman) "." counter(toc-sec-section, upper-roman) "." counter(toc-sec-sub-section, upper-roman) "." counter(toc-sec-composite, upper-roman) "." counter(toc-sec-detail, upper-roman) "." counter(toc-last, upper-roman) " "; +} + diff --git a/css/print-site-material.css b/css/print-site-material.css new file mode 100644 index 0000000..ca459dc --- /dev/null +++ b/css/print-site-material.css @@ -0,0 +1,38 @@ +/* print styles for mkdocs material theme +https://github.com/squidfunk/mkdocs-material */ + + +/* Table of Contents styling */ +#print-site-page ul.toc-section-line-border { + border-left: 5px solid var(--md-default-fg-color--lightest); +} + + +/* Box shadows don't do well in PDFs */ +#print-site-page table { + border: 1px solid hsla(200, 18%, 26%, 1); /* #EFEFEF */ + box-shadow: none !important; +} + +@media print { + #print-site-page td { + word-wrap: break-word; + } + +} + +@page { + + size: A4 portrait; + margin: 4em 1.5em 4em 1.5em; + padding: 0em 0em 0em 0em; + counter-increment: page; + + @bottom-center { + content: string(chapter); + } + @bottom-right { + content: 'Page ' counter(page); + } + +} \ No newline at end of file diff --git a/css/print-site.css b/css/print-site.css new file mode 100644 index 0000000..52f477f --- /dev/null +++ b/css/print-site.css @@ -0,0 +1,220 @@ + +/* +The print-site banner +*/ +#print-site-banner { + border:2px; + border-style:solid; + border-color:#000000; + padding: 0em 1em 0em 1em; + margin-bottom: 2em; +} +#print-site-banner h3 { + margin-top: 1rem; +} + +/* Enumerate figures */ +.print-site-enumerate-figures figcaption:before { + counter-increment: figurecounter; + content: "Figure " counter(figurecounter) ": "; +} + + +/* Print URLS: +Change a 'link' to 'link (target)' */ +div.print-site-add-full-url section.print-page a[href^="http"]::after{ + content: " (" attr(href) ") "; +} + + +/* Do some nice animations when clicking on a ToC link */ +#print-site-page h1:target, +#print-site-page h2:target, +#print-site-page h3:target, +#print-site-page h4:target, +#print-site-page h5:target, +#print-site-page h6:target { + animation: highlight 1.5s ease; +} +#print-site-page .print-page:target h1 { + animation: highlight 1.5s ease; +} +@keyframes highlight { + from { color: orange; } + to { color: none; } +} + + +/* +Print site table of contents styling + */ +/* Don't display the table of contents in HTML version */ +#print-page-toc { display: none } + + +.print-page-toc-nav { + padding-bottom: 2em; +} + +#print-page-toc ul { + /* margin-left: 1.6em; */ + margin-top: 0; + margin-bottom: 0; + padding-left: 0; + list-style-position: inside; +} +#print-page-toc ul.print-site-toc-level-2, +#print-page-toc ul.print-site-toc-level-3, +#print-page-toc ul.print-site-toc-level-4, +#print-page-toc ul.print-site-toc-level-5, +#print-page-toc ul.print-site-toc-level-6 { + margin-left: 1.6em; +} +#print-page-toc ul li { + margin-left: 0; + margin-bottom: 0.2em; +} +ul.print-site-toc-level-1 { + list-style-type: none; +} +ul.print-site-toc-level-1 li a { + font-weight: bold; + font-size: 120%; +} +ul.print-site-toc-level-2 li a { + font-weight: normal; + font-size: 100%; + margin-bottom: 0em; +} +#print-site-page ul li.toc-nav-section-title { + padding-top: 1em; + padding-bottom: 0em; + font-size: 110%; + letter-spacing: 1px; +} +#print-site-page ul.toc-section-line-border { + border-left: 5px solid grey; + padding-left: 1.5em; + margin-top: 0.5em; + margin-bottom: 1em; +} + + +#print-site-page ul { + margin-left: 0em; +} + + + + +/* Don't display the section headings that we added +For now, we added them for use only in the table of contents */ +#print-site-page h1.nav-section-title, +#print-site-page h2.nav-section-title, +#print-site-page h3.nav-section-title, +#print-site-page h4.nav-section-title, +#print-site-page h5.nav-section-title, +#print-site-page h6.nav-section-title { + padding-top: 1.5em; + padding-bottom: 1em; + padding-left: 1em; + font-size: 2.2em; + font-weight: 300; + line-height: 1.3; + color: var(--md-default-fg-color--light); +} +#print-site-page h1.nav-section-title-end, +#print-site-page h2.nav-section-title-end, +#print-site-page h3.nav-section-title-end, +#print-site-page h4.nav-section-title-end, +#print-site-page h5.nav-section-title-end, +#print-site-page h6.nav-section-title-end { display: none; } + +/* In the TOC, we want lines that are children of a section to be displayed with a left margin */ +#print-site-page ul li.toc-nav-section-child { padding-left: 1em; } + +/* Be able to not print certain elements */ +#print-site-page .print-site-plugin-ignore { display: none;} + + + +@media print { + + /* included bookmarks on h1 and h2 + Doesn't work, but included In case Chrome gets support + for these experimental CSS features that define PDF bookmarks */ + /* #print-site-page h1 { + bookmark-level: 1; + bookmark-label: content(); + -ah-bookmark-level: 1; + -ro-pdf-bookmark-level: 1; + } + #print-site-page h2 { + bookmark-level: 2; + bookmark-label: content(); + -ah-bookmark-level: 2; + -ro-pdf-bookmark-level: 2; + } */ + + /* Be able to not print certain elements */ + .print-site-plugin-ignore { display: none; } + + /* Remove print site banner */ + #print-site-banner { display: none; } + + /* display the table of contents in print version */ + #print-page-toc { display: block } + + /* PDF page breaks on each MkDocs page, except the first one */ + #print-site-page section.print-page { + page-break-before: always; + } + #print-site-page section.print-page:first-of-type { + page-break-before: avoid; + } + /* PDF page breaks - separate title page for each section */ + #print-site-page .nav-section-title { + page-break-before: always; + page-break-after: always; + align-content: center; + text-align: center; + vertical-align: middle; + padding-top: 150px !important; + padding-bottom: 0em; + padding-left: 0em; + font-size: 2.5em; + } + + #print-site-page p, + #print-site-page pre, + #print-site-page blockquote, + #print-site-page .tabbed-set { + page-break-inside: avoid; + } + + /* Avoid a page break immediately after a heading */ + /* Credits https://stackoverflow.com/a/9238898/5525118 */ + #print-site-page h1 { + page-break-inside: avoid; + } + #print-site-page h1::after { + content: ""; + display: block; + height: 100px; + margin-bottom: -100px; + } + + #print-site-page footer { display : none; } + + + #print-site-cover-page { + display: block; + width:100%; + text-align: center; + } + #print-site-cover-page h1 { + font-size: 300%; + } + +} + diff --git a/export.pdf b/export.pdf new file mode 100644 index 0000000..ff3567b Binary files /dev/null and b/export.pdf differ diff --git a/gcodes/index.html b/gcodes/index.html index 7930e8f..4fe303a 100644 --- a/gcodes/index.html +++ b/gcodes/index.html @@ -16,7 +16,7 @@ - + @@ -46,6 +46,22 @@ + + + + + + + + + + + + + + + + @@ -471,6 +487,20 @@
+ + + + + + + + + + + + + + @@ -521,6 +551,7 @@

UPDATE_MAINTENANCE

+
@@ -559,6 +590,8 @@

UPDATE_MAINTENANCE

+ + \ No newline at end of file diff --git a/index.html b/index.html index e54cd9f..acd4e19 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,7 @@ - + @@ -46,6 +46,22 @@ + + + + + + + + + + + + + + + + @@ -489,6 +505,20 @@
+ + + + + + + + + + + + + + @@ -538,6 +568,7 @@

Usage

+
@@ -576,6 +607,8 @@

Usage

+ + \ No newline at end of file diff --git a/install/index.html b/install/index.html index 5ff0982..c0af17f 100644 --- a/install/index.html +++ b/install/index.html @@ -18,7 +18,7 @@ - + @@ -48,6 +48,22 @@ + + + + + + + + + + + + + + + + @@ -455,6 +471,20 @@
+ + + + + + + + + + + + + + @@ -507,6 +537,7 @@

Update

+
@@ -545,6 +576,8 @@

Update

+ + \ No newline at end of file diff --git a/js/print-site.js b/js/print-site.js new file mode 100644 index 0000000..e743642 --- /dev/null +++ b/js/print-site.js @@ -0,0 +1,149 @@ +/* +Javascript functions to help make the print page more PDF friendly +*/ + +/* +Generates a table of contents for the print site page. +Only called when print-site-plugin option 'add_table_of_contents' is set to true +*/ +function generate_toc() { + + var ToC = "" + + var newLine, el, title, link; + + const toc_elements = document.querySelectorAll( + "#print-site-page h1.nav-section-title, #print-site-page h1.nav-section-title-end," + + "#print-site-page h2.nav-section-title, #print-site-page h2.nav-section-title-end," + + "#print-site-page h3.nav-section-title, #print-site-page h3.nav-section-title-end," + + "#print-site-page h4.nav-section-title, #print-site-page h4.nav-section-title-end," + + "#print-site-page h5.nav-section-title, #print-site-page h5.nav-section-title-end," + + "#print-site-page h6.nav-section-title, #print-site-page h6.nav-section-title-end," + + "section.print-page h1,section.print-page h2,section.print-page h3," + + "section.print-page h4,section.print-page h5,section.print-page h6") + + var current_heading_depth = 0; + var current_section_depth = 0; + + // Extract table of contents depth + // basically plugin setting, passed via a data attribute + var toc_depth = document.getElementById("print-page-toc").getAttribute("data-toc-depth") + + for (var i = 0; i < toc_elements.length; i++) { + + // Get the info from the element + el = toc_elements[i] + link = "#" + el.id; + tag = el.tagName + tag_level = tag.substring(1) + // Get the text of a heading + // We use .firstChild.nodeValue instead of .innerText + // because of elements like: + //

+ // mkdocs-print-site-plugin↵ + //

+ title = el.firstChild.nodeValue; + if ( ! title ) { + continue; + } + + // Don't put the toc h1 in the toc + if ( el.classList.contains('print-page-toc-title') ) { + continue; + } + // Ignore the MkDocs keyboard Model + if ( el.id.indexOf("keyboardModalLabel") > -1 ) { + continue; + } + + // print-site-plugin has a setting to control TOC depth + if ( tag_level > toc_depth ) { + continue; + } + + if (el.classList.contains('nav-section-title') ) { + // Use the tag level of the first item in the section to close off any nested " + + document.querySelectorAll("#print-page-toc nav")[0].insertAdjacentHTML("beforeend", ToC); + +} + + +function remove_material_navigation() { + + // Remove left sidebar on print page + remove_element_by_classname('md-sidebar--primary') + // Remove tabs navigation on print page + remove_element_by_classname('md-tabs') + // Remove search + remove_element_by_classname('md-search') + +} + +function remove_mkdocs_theme_navigation() { + + // Remove top navigation bar + remove_element_by_classname('navbar') +} + + +function remove_element_by_classname(class_name) { + var el = document.getElementsByClassName(class_name); + if( el.length > 0) { + el[0].style.display = "none" + } +} diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..2be33cf --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,18 @@ +{% extends "base.html" %} + +{% block content %} + +{% if page.url_to_print_page %} + + {% include ".icons/material/printer.svg" %} + +{% endif %} + +{% if page.url_to_pdf %} + + {% include ".icons/material/file-pdf-box.svg" %} + +{% endif %} + +{{ super() }} +{% endblock content %} \ No newline at end of file diff --git a/print_page/index.html b/print_page/index.html new file mode 100644 index 0000000..5f70ed5 --- /dev/null +++ b/print_page/index.html @@ -0,0 +1,632 @@ + + + + + + + + + + + + + + + + + + + + + Print Site - Klipper Maintenance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + + + +
+
+
+ +
+
+

Klipper Maintenance

+

Keep your 3D printer running smoothly

+

logo

+
+
+

Info

+

This is still a work in progress with partial testing.

+
+

Features

+

Klipper Maintenance supports the following features:

+
    +
  • Maintenance reminders in the terminal
    • +
  • Maintenance reminders on the printer display
    • +
  • Print time thresholds
    • +
  • Filament thresholds
    • +
  • Time thresholds
    • +
+

Get Started

+

Follow Installation to get started with Klipper Maintenance.

+

Configuration

+

After installing KlipperMaintenance, follow Configuration to configure KlipperMaintenance.

+

Usage

+

To use KlipperMaintenance, follow G-Codes.

Installation

+

Follow this guide to install or update KlipperMaintenance.

+

Install

+

To install KlipperMaintenance, run in your terminal:

+
cd ~
+git clone https://github.com/3DCoded/KlipperMaintenance
+cd KlipperMaintenance
+sh install.sh
+sudo service klipper restart
+
+

Add to your moonraker.conf:

+
moonraker.conf
# KlipperMaintenance Update Manager
+[update_manager KlipperMaintenance]
+type: git_repo
+path: ~/KlipperMaintenance
+origin: https://github.com/3DCoded/KlipperMaintenance.git
+primary_branch: main
+is_system_service: False
+install_script: install.sh
+
+

Update

+

To update KlipperMaintenance, update via Moonraker's update manager, then run in your terminal:

+
cd KlipperMaintenance
+sh install.sh
+sudo service klipper restart
+

Configuration

+

After installing KlipperMaintenance, follow this guide to configure it.

+

Main Section

+

First, a main [maintain] section must be configured. This has two main purposes:

+
    +
  1. Check periodically if maintenance needs to be done
    2. +
  2. Provide the MAINTAIN_STATUS command
    3. +
+

To configure it, add to your printer.cfg:

+
printer.cfg
[maintain]
+interval: 60 # optional, time (in seconds) between checking if maintenance needs to be done (default is 60)
+
+

Maintenance Sections

+

Next, for each maintenance object, a [maintain xxx] config section should be configured. In this example, three maintenance objects will be configured (note the times here are purely for demonstration and are probably not ideal):

+
    +
  1. Lubricate XY rods (250 hours print time)
    2. +
  2. Replace air filter (500 hours time)
    3. +
  3. Clean and tighten extruder screws (700m filament)
    4. +
+

For each [maintain xxx] section, there are four options that must be set:

+
    +
  • label text that will be displayed when referring to this maintenance object
    • +
  • trigger type of event that triggers this maintenance. Currently three options:
      +
    • print_time print time, in hours
      • +
    • filament extruded filament, in meters (330m is roughly 1kg of PLA)
      • +
    • time time, in hours
      • +
    +
    • +
  • threshold how often maintenance needs to be done. For print_time and time, this is in hours. For filament, this is in meters
    • +
  • message message that will be displayed when maintenance needs to be done
    • +
+

Example:

+
printer.cfg
# Lubricate XY rods
+[maintain xyrods]
+label: XY smooth rods
+trigger: print_time
+threshold: 250
+message: Lubricate XY smooth rods
+
+# Replace air filter
+[maintain airfilter]
+label: Air filter
+trigger: time
+threshold: 500
+message: Replace HEPA and charcoal filters
+
+# Extruder maintenance
+[maintain extruder]
+label: Extruder maintenance
+trigger: filament
+threshold: 700
+message: Clean extruder gears and tighten extruder bolts
+

G-Codes

+

KlipperMaintenance provides a few helper GCodes to manage your maintenance. Follow this guide to learn how to use them.

+

MAINTAIN_STATUS

+

Shows the current status of maintenance. Accepts no parameters. Using the example from Configuration and assuming air filter is expired, here is an example:

+
Input
MAINTAIN_STATUS
+
+
Output
XY smooth rods: 200h remaining
+Maintenance "Air filter" Expired!
+Replace HEPA and charcoal filters
+Extruder maintenance: 400m remaining
+
+

CHECK_MAINTENANCE

+

Shows the current status of provided maintenance. Example:

+
Input
CHECK_MAINTENANCE NAME=xyrods
+
+
Output
Maintenance xyrods Status:
+Next maintenance in 200h
+Maintenance message: Lubricate XY smooth rods
+
+

UPDATE_MAINTENANCE

+

Marks the provided maintenance as complete. Example:

+
input
UPDATE_MAINTENANCE NAME=xyrods
+
+

This resets the maintenance timer for the xyrods maintenance.

+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + + + \ No newline at end of file