From 2e7a475c34a5f1a2f1304a3fa7466fef18b78053 Mon Sep 17 00:00:00 2001 From: Oliver Kaufmann Date: Wed, 21 Jun 2023 09:07:55 +0200 Subject: [PATCH] bring back docs --- .github/workflows/publish-image.yml | 5 + docs.css | 1007 +++++++++++++++++++++++++++ 2 files changed, 1012 insertions(+) create mode 100644 docs.css diff --git a/.github/workflows/publish-image.yml b/.github/workflows/publish-image.yml index 65b308a..b464b99 100644 --- a/.github/workflows/publish-image.yml +++ b/.github/workflows/publish-image.yml @@ -20,6 +20,11 @@ jobs: steps: - uses: actions/checkout@v2 + - name: Generate Docs + run: | + docker run -v `pwd`:/source jagregory/pandoc --toc -c docs.css --self-contained -f markdown_github -t html5 README.md -o README.html + sed '/^\[!\[/d; /^!\[/d' README.md > README.txt + - name: Docker meta id: meta uses: docker/metadata-action@v4 diff --git a/docs.css b/docs.css new file mode 100644 index 0000000..c2497eb --- /dev/null +++ b/docs.css @@ -0,0 +1,1007 @@ +@@ -1, +1002+0, +0 @@ + +/* inspired by https://github.com/sindresorhus/github-markdown-css */ +body { + box-sizing: border-box; + min-width: 200px; + max-width: 980px; + margin: 0 auto; + padding: 45px; +} + +@media (max-width: 767px) { + body { + padding: 15px; + } +} + +html .octicon { + display: inline-block; + fill: currentColor; + vertical-align: text-bottom; +} + +html .anchor { + float: left; + line-height: 1; + margin-left: -20px; + padding-right: 4px; +} + +html .anchor:focus { + outline: none; +} + +html h1 .octicon-link, +html h2 .octicon-link, +html h3 .octicon-link, +html h4 .octicon-link, +html h5 .octicon-link, +html h6 .octicon-link { + color: #1b1f23; + vertical-align: middle; + visibility: hidden; +} + +html h1:hover .anchor, +html h2:hover .anchor, +html h3:hover .anchor, +html h4:hover .anchor, +html h5:hover .anchor, +html h6:hover .anchor { + text-decoration: none; +} + +html h1:hover .anchor .octicon-link, +html h2:hover .anchor .octicon-link, +html h3:hover .anchor .octicon-link, +html h4:hover .anchor .octicon-link, +html h5:hover .anchor .octicon-link, +html h6:hover .anchor .octicon-link { + visibility: visible; +} + +html h1:hover .anchor .octicon-link:before, +html h2:hover .anchor .octicon-link:before, +html h3:hover .anchor .octicon-link:before, +html h4:hover .anchor .octicon-link:before, +html h5:hover .anchor .octicon-link:before, +html h6:hover .anchor .octicon-link:before { + width: 16px; + height: 16px; + content: " "; + display: inline-block; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' version='1.1' width='16' height='16' aria-hidden='true'%3E%3Cpath fill-rule='evenodd' d='M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z'%3E%3C/path%3E%3C/svg%3E"); +} + +html { + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100%; + line-height: 1.5; + color: #24292e; + font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, + sans-serif, Apple Color Emoji, Segoe UI Emoji; + font-size: 16px; + line-height: 1.5; + word-wrap: break-word; +} + +html details { + display: block; +} + +html summary { + display: list-item; +} + +html a { + background-color: initial; +} + +html a:active, +html a:hover { + outline-width: 0; +} + +html strong { + font-weight: inherit; + font-weight: bolder; +} + +html h1 { + font-size: 2em; + margin: 0.67em 0; +} + +html img { + border-style: none; +} + +html code, +html kbd, +html pre { + font-family: monospace, monospace; + font-size: 1em; +} + +html hr { + box-sizing: initial; + height: 0; + overflow: visible; +} + +html input { + font: inherit; + margin: 0; +} + +html input { + overflow: visible; +} + +html [type="checkbox"] { + box-sizing: border-box; + padding: 0; +} + +html * { + box-sizing: border-box; +} + +html input { + font-family: inherit; + font-size: inherit; + line-height: inherit; +} + +html a { + color: #0366d6; + text-decoration: none; +} + +html a:hover { + text-decoration: underline; +} + +html strong { + font-weight: 600; +} + +html hr { + height: 0; + margin: 15px 0; + overflow: hidden; + background: transparent; + border: 0; + border-bottom: 1px solid #dfe2e5; +} + +html hr:after, +html hr:before { + display: table; + content: ""; +} + +html hr:after { + clear: both; +} + +html table { + border-spacing: 0; + border-collapse: collapse; +} + +html td, +html th { + padding: 0; +} + +html details summary { + cursor: pointer; +} + +html kbd { + display: inline-block; + padding: 3px 5px; + font: 11px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + line-height: 10px; + color: #444d56; + vertical-align: middle; + background-color: #fafbfc; + border: 1px solid #d1d5da; + border-radius: 3px; + box-shadow: inset 0 -1px 0 #d1d5da; +} + +html h1, +html h2, +html h3, +html h4, +html h5, +html h6 { + margin-top: 0; + margin-bottom: 0; +} + +html h1 { + font-size: 32px; +} + +html h1, +html h2 { + font-weight: 600; +} + +html h2 { + font-size: 24px; +} + +html h3 { + font-size: 20px; +} + +html h3, +html h4 { + font-weight: 600; +} + +html h4 { + font-size: 16px; +} + +html h5 { + font-size: 14px; +} + +html h5, +html h6 { + font-weight: 600; +} + +html h6 { + font-size: 12px; +} + +html p { + margin-top: 0; + margin-bottom: 10px; +} + +html blockquote { + margin: 0; +} + +html ol, +html ul { + padding-left: 0; + margin-top: 0; + margin-bottom: 0; +} + +html ol ol, +html ul ol { + list-style-type: lower-roman; +} + +html ol ol ol, +html ol ul ol, +html ul ol ol, +html ul ul ol { + list-style-type: lower-alpha; +} + +html dd { + margin-left: 0; +} + +html code, +html pre { + font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + font-size: 12px; +} + +html pre { + margin-top: 0; + margin-bottom: 0; +} + +html input::-webkit-inner-spin-button, +html input::-webkit-outer-spin-button { + margin: 0; + -webkit-appearance: none; + appearance: none; +} + +html :checked+.radio-label { + position: relative; + z-index: 1; + border-color: #0366d6; +} + +html .border { + border: 1px solid #e1e4e8 !important; +} + +html .border-0 { + border: 0 !important; +} + +html .border-bottom { + border-bottom: 1px solid #e1e4e8 !important; +} + +html .rounded-1 { + border-radius: 3px !important; +} + +html .bg-white { + background-color: #fff !important; +} + +html .bg-gray-light { + background-color: #fafbfc !important; +} + +html .text-gray-light { + color: #6a737d !important; +} + +html .mb-0 { + margin-bottom: 0 !important; +} + +html .my-2 { + margin-top: 8px !important; + margin-bottom: 8px !important; +} + +html .pl-0 { + padding-left: 0 !important; +} + +html .py-0 { + padding-top: 0 !important; + padding-bottom: 0 !important; +} + +html .pl-1 { + padding-left: 4px !important; +} + +html .pl-2 { + padding-left: 8px !important; +} + +html .py-2 { + padding-top: 8px !important; + padding-bottom: 8px !important; +} + +html .pl-3, +html .px-3 { + padding-left: 16px !important; +} + +html .px-3 { + padding-right: 16px !important; +} + +html .pl-4 { + padding-left: 24px !important; +} + +html .pl-5 { + padding-left: 32px !important; +} + +html .pl-6 { + padding-left: 40px !important; +} + +html .f6 { + font-size: 12px !important; +} + +html .lh-condensed { + line-height: 1.25 !important; +} + +html .text-bold { + font-weight: 600 !important; +} + +html .pl-c { + color: #6a737d; +} + +html .pl-c1, +html .pl-s .pl-v { + color: #005cc5; +} + +html .pl-e, +html .pl-en { + color: #6f42c1; +} + +html .pl-s .pl-s1, +html .pl-smi { + color: #24292e; +} + +html .pl-ent { + color: #22863a; +} + +html .pl-k { + color: #d73a49; +} + +html .pl-pds, +html .pl-s, +html .pl-s .pl-pse .pl-s1, +html .pl-sr, +html .pl-sr .pl-cce, +html .pl-sr .pl-sra, +html .pl-sr .pl-sre { + color: #032f62; +} + +html .pl-smw, +html .pl-v { + color: #e36209; +} + +html .pl-bu { + color: #b31d28; +} + +html .pl-ii { + color: #fafbfc; + background-color: #b31d28; +} + +html .pl-c2 { + color: #fafbfc; + background-color: #d73a49; +} + +html .pl-c2:before { + content: "^M"; +} + +html .pl-sr .pl-cce { + font-weight: 700; + color: #22863a; +} + +html .pl-ml { + color: #735c0f; +} + +html .pl-mh, +html .pl-mh .pl-en, +html .pl-ms { + font-weight: 700; + color: #005cc5; +} + +html .pl-mi { + font-style: italic; + color: #24292e; +} + +html .pl-mb { + font-weight: 700; + color: #24292e; +} + +html .pl-md { + color: #b31d28; + background-color: #ffeef0; +} + +html .pl-mi1 { + color: #22863a; + background-color: #f0fff4; +} + +html .pl-mc { + color: #e36209; + background-color: #ffebda; +} + +html .pl-mi2 { + color: #f6f8fa; + background-color: #005cc5; +} + +html .pl-mdr { + font-weight: 700; + color: #6f42c1; +} + +html .pl-ba { + color: #586069; +} + +html .pl-sg { + color: #959da5; +} + +html .pl-corl { + text-decoration: underline; + color: #032f62; +} + +html .mb-0 { + margin-bottom: 0 !important; +} + +html .my-2 { + margin-bottom: 8px !important; +} + +html .my-2 { + margin-top: 8px !important; +} + +html .pl-0 { + padding-left: 0 !important; +} + +html .py-0 { + padding-top: 0 !important; + padding-bottom: 0 !important; +} + +html .pl-1 { + padding-left: 4px !important; +} + +html .pl-2 { + padding-left: 8px !important; +} + +html .py-2 { + padding-top: 8px !important; + padding-bottom: 8px !important; +} + +html .pl-3 { + padding-left: 16px !important; +} + +html .pl-4 { + padding-left: 24px !important; +} + +html .pl-5 { + padding-left: 32px !important; +} + +html .pl-6 { + padding-left: 40px !important; +} + +html .pl-7 { + padding-left: 48px !important; +} + +html .pl-8 { + padding-left: 64px !important; +} + +html .pl-9 { + padding-left: 80px !important; +} + +html .pl-10 { + padding-left: 96px !important; +} + +html .pl-11 { + padding-left: 112px !important; +} + +html .pl-12 { + padding-left: 128px !important; +} + +html hr { + border-bottom-color: #eee; +} + +html kbd { + display: inline-block; + padding: 3px 5px; + font: 11px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + line-height: 10px; + color: #444d56; + vertical-align: middle; + background-color: #fafbfc; + border: 1px solid #d1d5da; + border-radius: 3px; + box-shadow: inset 0 -1px 0 #d1d5da; +} + +html:after, +html:before { + display: table; + content: ""; +} + +html:after { + clear: both; +} + +html> :first-child { + margin-top: 0 !important; +} + +html> :last-child { + margin-bottom: 0 !important; +} + +html a:not([href]) { + color: inherit; + text-decoration: none; +} + +html blockquote, +html details, +html dl, +html ol, +html p, +html pre, +html table, +html ul { + margin-top: 0; + margin-bottom: 16px; +} + +html hr { + height: 0.25em; + padding: 0; + margin: 24px 0; + background-color: #e1e4e8; + border: 0; +} + +html blockquote { + padding: 0 1em; + color: #6a737d; + border-left: 0.25em solid #dfe2e5; +} + +html blockquote> :first-child { + margin-top: 0; +} + +html blockquote> :last-child { + margin-bottom: 0; +} + +html h1, +html h2, +html h3, +html h4, +html h5, +html h6 { + margin-top: 24px; + margin-bottom: 16px; + font-weight: 600; + line-height: 1.25; +} + +html h1 { + font-size: 2em; +} + +html h1, +html h2 { + padding-bottom: 0.3em; + border-bottom: 1px solid #eaecef; +} + +html h2 { + font-size: 1.5em; +} + +html h3 { + font-size: 1.25em; +} + +html h4 { + font-size: 1em; +} + +html h5 { + font-size: 0.875em; +} + +html h6 { + font-size: 0.85em; + color: #6a737d; +} + +html ol, +html ul { + padding-left: 2em; +} + +html ol ol, +html ol ul, +html ul ol, +html ul ul { + margin-top: 0; + margin-bottom: 0; +} + +html li { + word-wrap: break-all; +} + +html li>p { + margin-top: 16px; +} + +html li+li { + margin-top: 0.25em; +} + +html dl { + padding: 0; +} + +html dl dt { + padding: 0; + margin-top: 16px; + font-size: 1em; + font-style: italic; + font-weight: 600; +} + +html dl dd { + padding: 0 16px; + margin-bottom: 16px; +} + +html table { + display: block; + width: 100%; + overflow: auto; +} + +html table th { + font-weight: 600; +} + +html table td, +html table th { + padding: 6px 13px; + border: 1px solid #dfe2e5; +} + +html table tr { + background-color: #fff; + border-top: 1px solid #c6cbd1; +} + +html table tr:nth-child(2n) { + background-color: #f6f8fa; +} + +html img { + max-width: 100%; + box-sizing: initial; + background-color: #fff; +} + +html img[align="right"] { + padding-left: 20px; +} + +html img[align="left"] { + padding-right: 20px; +} + +html code { + padding: 0.2em 0.4em; + margin: 0; + font-size: 85%; + background-color: rgba(27, 31, 35, 0.05); + border-radius: 3px; +} + +html pre { + word-wrap: normal; +} + +html pre>code { + padding: 0; + margin: 0; + font-size: 100%; + word-break: normal; + white-space: pre; + background: transparent; + border: 0; +} + +html .highlight { + margin-bottom: 16px; +} + +html .highlight pre { + margin-bottom: 0; + word-break: normal; +} + +html .highlight pre, +html pre { + padding: 16px; + overflow: auto; + font-size: 85%; + line-height: 1.45; + background-color: #f6f8fa; + border-radius: 3px; +} + +html pre code { + display: inline; + max-width: auto; + padding: 0; + margin: 0; + overflow: visible; + line-height: inherit; + word-wrap: normal; + background-color: initial; + border: 0; +} + +html .commit-tease-sha { + display: inline-block; + font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + font-size: 90%; + color: #444d56; +} + +html .full-commit .btn-outline:not(:disabled):hover { + color: #005cc5; + border-color: #005cc5; +} + +html .blob-wrapper { + overflow-x: auto; + overflow-y: hidden; +} + +html .blob-wrapper-embedded { + max-height: 240px; + overflow-y: auto; +} + +html .blob-num { + width: 1%; + min-width: 50px; + padding-right: 10px; + padding-left: 10px; + font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + font-size: 12px; + line-height: 20px; + color: rgba(27, 31, 35, 0.3); + text-align: right; + white-space: nowrap; + vertical-align: top; + cursor: pointer; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +html .blob-num:hover { + color: rgba(27, 31, 35, 0.6); +} + +html .blob-num:before { + content: attr(data-line-number); +} + +html .blob-code { + position: relative; + padding-right: 10px; + padding-left: 10px; + line-height: 20px; + vertical-align: top; +} + +html .blob-code-inner { + overflow: visible; + font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + font-size: 12px; + color: #24292e; + word-wrap: normal; + white-space: pre; +} + +html .pl-token.active, +html .pl-token:hover { + cursor: pointer; + background: #ffea7f; +} + +html .tab-size[data-tab-size="1"] { + -moz-tab-size: 1; + tab-size: 1; +} + +html .tab-size[data-tab-size="2"] { + -moz-tab-size: 2; + tab-size: 2; +} + +html .tab-size[data-tab-size="3"] { + -moz-tab-size: 3; + tab-size: 3; +} + +html .tab-size[data-tab-size="4"] { + -moz-tab-size: 4; + tab-size: 4; +} + +html .tab-size[data-tab-size="5"] { + -moz-tab-size: 5; + tab-size: 5; +} + +html .tab-size[data-tab-size="6"] { + -moz-tab-size: 6; + tab-size: 6; +} + +html .tab-size[data-tab-size="7"] { + -moz-tab-size: 7; + tab-size: 7; +} + +html .tab-size[data-tab-size="8"] { + -moz-tab-size: 8; + tab-size: 8; +} + +html .tab-size[data-tab-size="9"] { + -moz-tab-size: 9; + tab-size: 9; +} + +html .tab-size[data-tab-size="10"] { + -moz-tab-size: 10; + tab-size: 10; +} + +html .tab-size[data-tab-size="11"] { + -moz-tab-size: 11; + tab-size: 11; +} + +html .tab-size[data-tab-size="12"] { + -moz-tab-size: 12; + tab-size: 12; +} + +html .task-list-item { + list-style-type: none; +} + +html .task-list-item+.task-list-item { + margin-top: 3px; +} + +html .task-list-item input { + margin: 0 0.2em 0.25em -1.6em; + vertical-align: middle; +} \ No newline at end of file