7 Commits

Author SHA1 Message Date
099f2a68de 0.1.4 2023-05-20 19:08:55 -07:00
e5f7af48cb support for rss/calendar 2023-05-20 19:08:43 -07:00
5689c64c4e work on splitting up extras css; start handling build metadata; start building sitemaps 2023-05-19 00:00:15 -07:00
bf390c324f 0.1.3 2023-05-14 19:59:43 -07:00
ab40bf4a09 more extras 2023-05-14 19:59:38 -07:00
a02d6c429c 0.1.2 2023-05-13 22:21:23 -07:00
03fbc802cb add npmignore 2023-05-13 22:21:16 -07:00
29 changed files with 2522 additions and 502 deletions

3
.npmignore Normal file
View File

@@ -0,0 +1,3 @@
.editorconfig
readme.md
tsconfig.json

View File

View File

@@ -0,0 +1,174 @@
label {
display: block;
color: var(--theme-text-body);
font-family: var(--font-body);
font-size: 1rem;
margin-block-start: 1rem;
}
label:not(:first-of-type) {
margin-block-start: 2rem;
}
label.radio {
display: flex;
margin-block: 1rem;
justify-content: flex-start;
}
input,
textarea {
display: block;
margin-block-start: 0.35rem;
margin-block-end: 1rem;
border: 0.125rem var(--theme-border-input) solid;
border-radius: 0.25rem;
color: var(--theme-text-body);
background-color: var(--theme-bg-input);
padding: 0.5rem;
font-family: var(--font-body);
font-size: 1rem;
width: 20rem;
}
input[disabled],
textarea[disabled] {
opacity: 0.4;
cursor: default;
pointer-events: none;
}
input[type='text']:invalid,
input[type='password']:invalid,
textarea:invalid {
border-color: var(--theme-border-input-invalid);
}
input[type='text'][readonly] {
color: var(--theme-text-light);
border-color: var(--theme-line);
}
input[type='checkbox'] {
width: 1rem;
height: 1rem;
padding: 0;
}
input[type='checkbox'] + label {
margin-inline-start: 0.5rem;
margin-inline-end: 2rem;
}
input[type='radio'] {
flex: 0 0 2rem;
margin: 0.2rem;
}
textarea {
line-height: 1.7rem;
font-family: var(--font-monospace);
}
::-webkit-input-placeholder {
color: var(--theme-text-light);
}
button {
padding: 0.5rem 1.5rem;
border-radius: 0.5rem;
font-size: 1rem;
margin-block-start: 1rem;
margin-inline-end: 1rem;
cursor: pointer;
user-select: none;
appearance: none;
color: var(--theme-text-button-primary);
background: var(--theme-bg-button-primary);
text-decoration: none;
font-size: 1rem;
font-family: var(--font-body);
font-weight: 700;
line-height: 2rem;
display: flex;
align-items: center;
}
button.icon-only {
padding: 0.5rem;
}
button svg.icon {
--icon-size: 2rem;
}
button:not(.icon-only) svg.icon:first-child {
margin-inline-end: 0.5rem;
}
button:not(.icon-only) svg.icon:last-child {
margin-inline-start: 0.5rem;
}
button[data-style='secondary'] {
color: var(--theme-text-button-secondary);
background: var(--theme-bg-button-secondary);
}
button:not([disabled]):hover {
background: var(--theme-bg-button-primary-hover);
}
button[data-style='secondary']:not([disabled]):hover {
background: var(--theme-bg-button-secondary-hover);
}
button[disabled] {
opacity: 0.4;
cursor: default;
pointer-events: none;
}
select {
display: block;
margin-block-start: 0.35rem;
margin-block-end: 1rem;
border: 0.125rem var(--theme-border-input) solid;
border-radius: 0.25rem;
color: var(--theme-text-body);
background-color: var(--theme-bg-input);
padding: 0.5rem;
font-family: var(--font-body);
font-size: 1rem;
width: 20rem;
cursor: pointer;
}
select[disabled] {
opacity: 0.4;
cursor: default;
pointer-events: none;
}
select option {
color: var(--theme-text-body);
background-color: var(--theme-bg-input);
padding: 0.5rem;
font-family: var(--font-body);
font-size: 1rem;
}
:is(table, .table) :is(input, select) {
margin-block: 0;
}
p.error-box {
margin: 0;
padding: 0.5rem;
border-radius: 0.25rem;
color: var(--theme-text-error-box);
background: var(--theme-bg-error-box);
border: 0.1rem solid var(--theme-border-error-box);
}

View File

112
extras/theme-animation.css Normal file
View File

@@ -0,0 +1,112 @@
/* todo: is there a better way to handle defining these animations? despite efforts,
this implementation still has some degree of transition stacking / delays in nested
svg contexts in chrome */
/* BG Color Only */
body[data-color-transition-enabled],
body[data-color-transition-enabled] :is(
[data-bg-transition]:not([data-color-transition]):not([data-border-transition]),
button
) {
transition: background linear .5s;
}
/* Border Color Only */
body[data-color-transition-enabled] :is(
[data-border-transition]:not([data-bg-transition]):not([data-color-transition])
) {
transition: border-color linear .5s;
}
/* Color Only */
body[data-color-transition-enabled] :is(
[data-color-transition]:not([data-bg-transition]):not([data-border-transition]),
p,
a:not(h1 a),
span:not(p span),
time:not(p time),
li:not([role='doc-footnote']), dt, dd,
h1, h2, h3, h4, h5, h6,
td, th
) {
transition: color linear .5s;
}
/* BG and Color */
body[data-color-transition-enabled] :is(
[data-bg-transition][data-color-transition]:not([data-border-transition]),
pre,
code:not(pre code),
samp:not(pre samp),
mark,
[role='doc-footnote']
) {
transition:
color linear .5s,
background linear .5s;
}
/* BG and Border */
body[data-color-transition-enabled] :is(
[data-bg-transition][data-border-transition]:not([data-color-transition]),
body > footer,
p.error-box,
.popup form,
#outline
) {
transition:
background linear .5s,
border-color linear .5s;
}
/** Color and Border */
body[data-color-transition-enabled] :is(
[data-color-transition][data-border-transition]:not([data-bg-transition]),
tbody tr,
.tbody .tr
) {
transition:
color linear .5s,
border-color linear .5s;
}
/* BG, Color, and Border */
body[data-color-transition-enabled] :is(
[data-bg-transition][data-border-transition][data-color-transition],
input, textarea, select,
blockquote,
:is(section, aside):is([role='note'], .info, .highlight, .warning, .problem)
) {
transition:
color linear .5s,
background linear .5s,
border-color linear .5s;
}
/* Fill and Stroke */
body[data-color-transition-enabled] svg :is(
[fill^='var('][stroke^='var(']:not([fill^='var('][stroke^='var('] *),
[style*='fill:'][style*='stroke:']:not([style*='fill:'][style*='stroke:'] *)
) {
transition:
fill linear .5s,
stroke linear .5s;
}
/* Fill Only */
body[data-color-transition-enabled] svg :is(
[fill^='var(']:not([stroke^='var(']):not([fill^='var('] *),
[style*='fill:']:not([style*='stroke:']):not([style*='fill:'] *)
) {
transition: fill linear .5s;
}
/* Stroke Only */
body[data-color-transition-enabled] :is(
svg [stroke^='var(']:not([fill^='var(']):not([stroke^='var('] *),
svg [style*='stroke:']:not([style*='fill:']):not([style*='stroke:'] *)
svg.icon
) {
transition: stroke linear .5s;
}

View File

@@ -0,0 +1,54 @@
:root {
font-size: 14px;
}
@media (max-width: 400px) {
:root {
font-size: 12px;
}
}
@media (min-width: 1600px) or (min-height: 1600px) {
:root {
font-size: calc(12px + 80vw / 400);
}
}
@media print {
:root {
font-size: 12px;
}
}
/* ===== Headings ===== */
h2 {
margin-block: 2.5rem 1rem;
}
/* ===== Paragraphs ===== */
p {
line-height: 1.5;
margin-block: 1rem;
}
/* ===== Lists ===== */
li {
line-height: 1.5;
margin-block: 0.25rem;
}

View File

@@ -0,0 +1,404 @@
/* ===== Headings ===== */
h1, h2, h3, h4, h5, h6 {
font-family: var(--font-heading);
line-height: 1;
color: var(--theme-text-heading);
}
h1 {
font-size: 2rem;
font-weight: 300;
margin-block-end: 1rem;
}
h2 {
font-size: 2rem;
font-weight: 500;
}
h3 {
font-size: 1.17rem;
}
h3, h4, h5, h6 {
margin-block: 3rem 1rem;
}
h5, h6 {
font-size: 0.9rem;
font-weight: 600;
}
h6 {
font-weight: 500;
}
:not(li) > :is(h1, h2, h3, h4, h5, h6),
li > :is(h1, h2, h3, h4, h5, h6):not(:first-child) {
padding-block-start: 1rem;
}
:is(h1, h2, h3, h4, h5, h6) + :is(h1, h2, h3),
:is(h1, h2, h3):first-child {
margin-block-start: 1rem;
}
:is(h1, h2, h3, h4, h5, h6) + :is(h4, h5, h6),
:is(h4, h5, h6):first-child {
margin-block-start: 0;
}
a.heading-anchor {
color: var(--theme-text-light);
opacity: 0.3;
margin-inline-start: 0.5rem;
}
:is(h1, h2, h3, h4, h5, h6):hover > a.heading-anchor {
opacity: 1;
}
:is(h1, h2, h3, h4, h5, h6) svg.icon:not(.heading-anchor > svg) {
--icon-size: 1em;
}
/* ===== Paragraphs ===== */
p {
margin-inline: 0;
font-size: 1rem;
font-family: var(--font-body);
color: var(--theme-text-body);
}
/* ===== Links ===== */
a {
font-family: inherit;
color: var(--theme-text-link);
}
a:active,
a:hover,
a:focus {
color: var(--theme-text-link-active);
}
a:visited {
color: var(--theme-text-link-visited);
}
a.icon-link {
display: inline-flex;
column-gap: 0.3rem;
align-items: center;
}
a.icon-link svg.icon {
--icon-size: 1rem;
}
/* ===== Lists ===== */
ul, ol {
padding-inline-start: 2.5rem;
}
li, dt, dd {
font-family: var(--font-body);
color: var(--theme-text-body);
}
li {
font-size: 1rem;
}
ul[role='doc-endnotes'] {
list-style: none;
padding-inline-start: 1rem;
}
[role='doc-footnote']:target {
background: var(--theme-bg-heavy);
}
dl {
padding: 1rem;
}
dt, dd {
/* */
}
dt {
font-weight: 700;
}
dt p {
margin-block-end: 1rem;
}
dt:not(:first-of-type) {
margin-block-start: 2rem;
}
/* dd {
margin-inline-start: 1rem;
padding-inline-start: 1rem;
padding-block: 0.125rem;
border-inline-start: 0.5rem var(--theme-line) solid;
background: var(--theme-bg-heavy)
} */
dd p {
margin-block: 1rem;
}
.cite-label {
font-weight: 600;
}
/* ===== Mark / Highlight ===== */
mark {
color: var(--theme-text-highlight);
background-color: var(--theme-bg-text-highlight);
padding: 0.2rem;
}
/* ===== User Selection ===== */
::selection {
fill: var(--theme-text-selection) !important;
color: var(--theme-text-selection) !important;
background-color: var(--theme-bg-text-selection) !important;
}
/* ===== Tables ===== */
table, .table, td, .td {
color: var(--theme-text-body);
font-family: var(--font-body);
}
table, .table {
display: table;
margin-block: 2rem;
border-collapse: collapse;
}
table, th, td,
.table, .th, .td {
font-size: 1rem;
line-height: 1.75;
}
thead, .thead {
display: table-header-group;
}
tbody, .tbody {
display: table-row-group;
}
tbody tr,
.tbody .tr {
border-top: 1px var(--theme-line) solid;
}
tr, .tr {
display: table-row;
}
th, .th {
text-align: center;
font-weight: 700;
color: var(--theme-text-heading);
}
th, .th,
td, .td {
padding-block: 0.5rem;
padding-inline: 1rem;
display: table-cell;
}
td, .td {
display: table-cell;
font-weight: 300;
vertical-align: top;
}
:is(td, .td):not(:last-of-type) {
border-inline-end: 0.1rem solid var(--theme-line);
}
:is(table, .table) :is(input, select) {
margin-block: 0;
}
table dl {
padding: 0;
}
/* ===== Pre-formatted Blocks ===== */
pre {
color: var(--theme-code-normal);
font-family: var(--font-monospace);
margin-block: 3rem;
margin-inline: 2rem;
padding-block: 0.5rem;
padding-inline: 1rem;
border: 0.1rem solid var(--theme-line);
border-radius: 1rem;
font-size: 1rem;
overflow: auto;
background: var(--theme-bg-light);
}
/* ===== Code / Sample Output ===== */
code, samp {
font-size: 1rem;
color: var(--theme-code-normal);
font-family: var(--font-monospace);
}
:not(pre) > :is(code, samp) {
color: inherit;
background: var(--theme-bg-light);
padding-inline: 0.25rem;
border: 0.1rem solid var(--theme-line);
}
/* ===== Note Blocks ===== */
:is(aside, section):is([role='note'], .info, .highlight, .warning, .problem) {
font-size: 1rem;
color: var(--theme-text-light);
padding-block: 0.6rem;
padding-inline-start: 1rem;
margin: 1rem;
border-inline-start: 0.8rem solid var(--theme-line);
background: var(--theme-bg-light);
}
:is(aside, section).info {
border-inline-start-color: var(--theme-accent-info);
}
:is(aside, section).highlight {
border-inline-start-color: var(--theme-accent-highlight);
}
:is(aside, section).warning {
border-inline-start-color: var(--theme-accent-warning);
}
:is(aside, section).problem {
border-inline-start-color: var(--theme-accent-problem);
}
/* ===== Figure Captions ===== */
figcaption {
font-family: var(--font-body);
text-align: center;
font-size: 0.85rem;
margin-block-start: 1rem;
color: var(--theme-text-light);
max-width: 60vw;
margin-inline: auto;
}
/* ===== Block Quotes ===== */
blockquote {
margin-block: 2rem;
margin-inline: 1rem;
padding-block: 0.5rem;
padding-inline: 1.5rem;
border-inline-start: 0.25rem var(--theme-line) solid;
}
blockquote p {
margin: 0;
}
/* ===== Small Spans ===== */
small {
font-size: 0.8rem;
font-family: var(--font-body);
color: var(--theme-text-body);
}
/* ===== Horizontal Rules ===== */
hr {
border-block-start-width: 0.1rem;
border-style: solid;
border-color: var(--theme-line);
width: 90%;
margin-block: 4rem 6rem;
}

View File

@@ -0,0 +1,54 @@
:root {
font-size: 16px;
}
@media (max-width: 400px) {
:root {
font-size: 14px;
}
}
@media (min-width: 1600px) or (min-height: 1600px) {
:root {
font-size: calc(12px + 100vw / 400);
}
}
@media print {
:root {
font-size: 12px;
}
}
/* ===== Headings ===== */
h2 {
margin-block: 4rem 1rem;
}
/* ===== Paragraphs ===== */
p {
line-height: 1.75;
margin-block: 1.25rem;
}
/* ===== Lists ===== */
li {
line-height: 1.75;
margin-block: 0.5rem;
}

495
package-lock.json generated
View File

@@ -1,25 +1,29 @@
{ {
"name": "@doc-utils/docs2website", "name": "@doc-utils/docs2website",
"version": "0.1.1", "version": "0.1.4",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@doc-utils/docs2website", "name": "@doc-utils/docs2website",
"version": "0.1.1", "version": "0.1.4",
"dependencies": { "dependencies": {
"@doc-utils/color-themes": "^0.1.14", "@doc-utils/color-themes": "^0.1.14",
"@doc-utils/jsonschema2markdown": "^0.1.1", "@doc-utils/jsonschema2markdown": "^0.1.1",
"@doc-utils/markdown2html": "^0.1.21", "@doc-utils/markdown2html": "^0.2.1",
"glob": "^10.2.3", "glob": "^10.2.3",
"ical": "^0.8.0",
"ical-generator": "^4.1.0",
"luxon": "^3.3.0", "luxon": "^3.3.0",
"mustache": "^4.2.0", "mustache": "^4.2.0",
"xmlbuilder2": "^3.1.1",
"yaml": "^2.2.2" "yaml": "^2.2.2"
}, },
"bin": { "bin": {
"docs2website": "bin/docs2website" "docs2website": "bin/docs2website"
}, },
"devDependencies": { "devDependencies": {
"@types/ical": "^0.8.0",
"@types/jsdom": "^20.0.1", "@types/jsdom": "^20.0.1",
"@types/luxon": "^3.3.0", "@types/luxon": "^3.3.0",
"@types/mustache": "^4.2.2", "@types/mustache": "^4.2.2",
@@ -47,15 +51,15 @@
} }
}, },
"node_modules/@doc-utils/markdown2html": { "node_modules/@doc-utils/markdown2html": {
"version": "0.1.21", "version": "0.2.6",
"resolved": "https://gitea.jbrumond.me/api/packages/doc-utils/npm/%40doc-utils%2Fmarkdown2html/-/0.1.21/markdown2html-0.1.21.tgz", "resolved": "https://gitea.jbrumond.me/api/packages/doc-utils/npm/%40doc-utils%2Fmarkdown2html/-/0.2.6/markdown2html-0.2.6.tgz",
"integrity": "sha512-yoyWrOOm4NNvxvzGn0oFwGgJb8xwmdQcAzgvN2s+xIC2sVL1WBirOlM+iJ1pOhXfAiKEPqzgEim+SE74siWp9Q==", "integrity": "sha512-6cQNzthYOOlkT6rr6E1lpSJ4Zq991+chblSRxv69SVT8y5cIs6c9tFu75MXoIKX4+H68Q4i10gtMrrsXD+bkaA==",
"dependencies": { "dependencies": {
"bytefield-svg": "^1.6.1", "bytefield-svg": "^1.6.1",
"dompurify": "^2.3.6", "dompurify": "^2.3.6",
"jsdom": "^20.0.1", "jsdom": "^20.0.1",
"katex": "^0.16.7", "katex": "^0.16.7",
"marked": "^4.1.1", "marked": "^5.0.2",
"nomnoml": "^1.5.2", "nomnoml": "^1.5.2",
"pikchr": "^0.0.5", "pikchr": "^0.0.5",
"prismjs": "^1.29.0", "prismjs": "^1.29.0",
@@ -80,6 +84,50 @@
"node": ">=12" "node": ">=12"
} }
}, },
"node_modules/@oozcitak/dom": {
"version": "1.15.10",
"resolved": "https://registry.npmjs.org/@oozcitak/dom/-/dom-1.15.10.tgz",
"integrity": "sha512-0JT29/LaxVgRcGKvHmSrUTEvZ8BXvZhGl2LASRUgHqDTC1M5g1pLmVv56IYNyt3bG2CUjDkc67wnyZC14pbQrQ==",
"dependencies": {
"@oozcitak/infra": "1.0.8",
"@oozcitak/url": "1.0.4",
"@oozcitak/util": "8.3.8"
},
"engines": {
"node": ">=8.0"
}
},
"node_modules/@oozcitak/infra": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/@oozcitak/infra/-/infra-1.0.8.tgz",
"integrity": "sha512-JRAUc9VR6IGHOL7OGF+yrvs0LO8SlqGnPAMqyzOuFZPSZSXI7Xf2O9+awQPSMXgIWGtgUf/dA6Hs6X6ySEaWTg==",
"dependencies": {
"@oozcitak/util": "8.3.8"
},
"engines": {
"node": ">=6.0"
}
},
"node_modules/@oozcitak/url": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/@oozcitak/url/-/url-1.0.4.tgz",
"integrity": "sha512-kDcD8y+y3FCSOvnBI6HJgl00viO/nGbQoCINmQ0h98OhnGITrWR3bOGfwYCthgcrV8AnTJz8MzslTQbC3SOAmw==",
"dependencies": {
"@oozcitak/infra": "1.0.8",
"@oozcitak/util": "8.3.8"
},
"engines": {
"node": ">=8.0"
}
},
"node_modules/@oozcitak/util": {
"version": "8.3.8",
"resolved": "https://registry.npmjs.org/@oozcitak/util/-/util-8.3.8.tgz",
"integrity": "sha512-T8TbSnGsxo6TDBJx/Sgv/BlVJL3tshxZP7Aq5R1mSnM5OcHY2dQaxLMu2+E8u3gN0MLOzdjurqN4ZRVuzQycOQ==",
"engines": {
"node": ">=8.0"
}
},
"node_modules/@pkgjs/parseargs": { "node_modules/@pkgjs/parseargs": {
"version": "0.11.0", "version": "0.11.0",
"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
@@ -107,6 +155,43 @@
"resolved": "https://registry.npmjs.org/@types/geojson/-/geojson-7946.0.4.tgz", "resolved": "https://registry.npmjs.org/@types/geojson/-/geojson-7946.0.4.tgz",
"integrity": "sha512-MHmwBtCb7OCv1DSivz2UNJXPGU/1btAWRKlqJ2saEhVJkpkvqHMMaOpKg0v4sAbDWSQekHGvPVMM8nQ+Jen03Q==" "integrity": "sha512-MHmwBtCb7OCv1DSivz2UNJXPGU/1btAWRKlqJ2saEhVJkpkvqHMMaOpKg0v4sAbDWSQekHGvPVMM8nQ+Jen03Q=="
}, },
"node_modules/@types/ical": {
"version": "0.8.0",
"resolved": "https://registry.npmjs.org/@types/ical/-/ical-0.8.0.tgz",
"integrity": "sha512-46KAYxAwRuCh+jRgl9k5cTaXJJkB16gWpvMVPuog9UBBb2zXTf9M0MsfWYBQ21JohFSuMZfPTvk6tohqGr1tCg==",
"dev": true,
"dependencies": {
"rrule": "2.6.4"
}
},
"node_modules/@types/ical/node_modules/luxon": {
"version": "1.28.1",
"resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.1.tgz",
"integrity": "sha512-gYHAa180mKrNIUJCbwpmD0aTu9kV0dREDrwNnuyFAsO1Wt0EVYSZelPnJlbj9HplzXX/YWXHFTL45kvZ53M0pw==",
"dev": true,
"optional": true,
"engines": {
"node": "*"
}
},
"node_modules/@types/ical/node_modules/rrule": {
"version": "2.6.4",
"resolved": "https://registry.npmjs.org/rrule/-/rrule-2.6.4.tgz",
"integrity": "sha512-sLdnh4lmjUqq8liFiOUXD5kWp/FcnbDLPwq5YAc/RrN6120XOPb86Ae5zxF7ttBVq8O3LxjjORMEit1baluahA==",
"dev": true,
"dependencies": {
"tslib": "^1.10.0"
},
"optionalDependencies": {
"luxon": "^1.21.3"
}
},
"node_modules/@types/ical/node_modules/tslib": {
"version": "1.14.1",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
"integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==",
"dev": true
},
"node_modules/@types/jsdom": { "node_modules/@types/jsdom": {
"version": "20.0.1", "version": "20.0.1",
"resolved": "https://registry.npmjs.org/@types/jsdom/-/jsdom-20.0.1.tgz", "resolved": "https://registry.npmjs.org/@types/jsdom/-/jsdom-20.0.1.tgz",
@@ -122,7 +207,7 @@
"version": "3.3.0", "version": "3.3.0",
"resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-3.3.0.tgz", "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-3.3.0.tgz",
"integrity": "sha512-uKRI5QORDnrGFYgcdAVnHvEIvEZ8noTpP/Bg+HeUzZghwinDlIS87DEenV5r1YoOF9G4x600YsUXLWZ19rmTmg==", "integrity": "sha512-uKRI5QORDnrGFYgcdAVnHvEIvEZ8noTpP/Bg+HeUzZghwinDlIS87DEenV5r1YoOF9G4x600YsUXLWZ19rmTmg==",
"dev": true "devOptional": true
}, },
"node_modules/@types/mustache": { "node_modules/@types/mustache": {
"version": "4.2.2", "version": "4.2.2",
@@ -131,10 +216,10 @@
"dev": true "dev": true
}, },
"node_modules/@types/node": { "node_modules/@types/node": {
"version": "18.16.9", "version": "18.16.13",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.9.tgz", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.13.tgz",
"integrity": "sha512-IeB32oIV4oGArLrd7znD2rkHQ6EDCM+2Sr76dJnrHwv9OHBTTM6nuDLK9bmikXzPa0ZlWMWtRGo/Uw4mrzQedA==", "integrity": "sha512-uZRomboV1vBL61EBXneL4j9/hEn+1Yqa4LQdpGrKmXFyJmVfWc9JV9+yb2AlnOnuaDnb2PDO3hC6/LKmzJxP1A==",
"dev": true "devOptional": true
}, },
"node_modules/@types/prismjs": { "node_modules/@types/prismjs": {
"version": "1.26.0", "version": "1.26.0",
@@ -214,6 +299,14 @@
"node": ">=4" "node": ">=4"
} }
}, },
"node_modules/argparse": {
"version": "1.0.10",
"resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
"integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
"dependencies": {
"sprintf-js": "~1.0.2"
}
},
"node_modules/array-back": { "node_modules/array-back": {
"version": "3.1.0", "version": "3.1.0",
"resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz",
@@ -939,14 +1032,14 @@
} }
}, },
"node_modules/glob": { "node_modules/glob": {
"version": "10.2.3", "version": "10.2.5",
"resolved": "https://registry.npmjs.org/glob/-/glob-10.2.3.tgz", "resolved": "https://registry.npmjs.org/glob/-/glob-10.2.5.tgz",
"integrity": "sha512-Kb4rfmBVE3eQTAimgmeqc2LwSnN0wIOkkUL6HmxEFxNJ4fHghYHVbFba/HcGcRjE6s9KoMNK3rSOwkL4PioZjg==", "integrity": "sha512-Gj+dFYPZ5hc5dazjXzB0iHg2jKWJZYMjITXYPBRQ/xc2Buw7H0BINknRTwURJ6IC6MEFpYbLvtgVb3qD+DwyuA==",
"dependencies": { "dependencies": {
"foreground-child": "^3.1.0", "foreground-child": "^3.1.0",
"jackspeak": "^2.0.3", "jackspeak": "^2.0.3",
"minimatch": "^9.0.0", "minimatch": "^9.0.0",
"minipass": "^5.0.0", "minipass": "^5.0.0 || ^6.0.2",
"path-scurry": "^1.7.0" "path-scurry": "^1.7.0"
}, },
"bin": { "bin": {
@@ -1008,6 +1101,82 @@
"node": ">= 6" "node": ">= 6"
} }
}, },
"node_modules/ical": {
"version": "0.8.0",
"resolved": "https://registry.npmjs.org/ical/-/ical-0.8.0.tgz",
"integrity": "sha512-/viUSb/RGLLnlgm0lWRlPBtVeQguQRErSPYl3ugnUaKUnzQswKqOG3M8/P1v1AB5NJwlHTuvTq1cs4mpeG2rCg==",
"dependencies": {
"rrule": "2.4.1"
}
},
"node_modules/ical-generator": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/ical-generator/-/ical-generator-4.1.0.tgz",
"integrity": "sha512-5GrFDJ8SAOj8cB9P1uEZIfKrNxSZ1R2eOQfZePL+CtdWh4RwNXWe8b0goajz+Hu37vcipG3RVldoa2j57Y20IA==",
"dependencies": {
"uuid-random": "^1.3.2"
},
"engines": {
"node": "^14.8.0 || >=16.0.0"
},
"peerDependencies": {
"@touch4it/ical-timezones": ">=1.6.0",
"@types/luxon": ">= 1.26.0",
"@types/mocha": ">= 8.2.1",
"@types/node": ">= 15.0.0",
"dayjs": ">= 1.10.0",
"luxon": ">= 1.26.0",
"moment": ">= 2.29.0",
"moment-timezone": ">= 0.5.33",
"rrule": ">= 2.6.8"
},
"peerDependenciesMeta": {
"@touch4it/ical-timezones": {
"optional": true
},
"@types/luxon": {
"optional": true
},
"@types/mocha": {
"optional": true
},
"@types/node": {
"optional": true
},
"dayjs": {
"optional": true
},
"luxon": {
"optional": true
},
"moment": {
"optional": true
},
"moment-timezone": {
"optional": true
},
"rrule": {
"optional": true
}
}
},
"node_modules/ical/node_modules/luxon": {
"version": "1.28.1",
"resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.1.tgz",
"integrity": "sha512-gYHAa180mKrNIUJCbwpmD0aTu9kV0dREDrwNnuyFAsO1Wt0EVYSZelPnJlbj9HplzXX/YWXHFTL45kvZ53M0pw==",
"optional": true,
"engines": {
"node": "*"
}
},
"node_modules/ical/node_modules/rrule": {
"version": "2.4.1",
"resolved": "https://registry.npmjs.org/rrule/-/rrule-2.4.1.tgz",
"integrity": "sha512-+NcvhETefswZq13T8nkuEnnQ6YgUeZaqMqVbp+ZiFDPCbp3AVgQIwUvNVDdMNrP05bKZG9ddDULFp0qZZYDrxg==",
"optionalDependencies": {
"luxon": "^1.3.3"
}
},
"node_modules/iconv-lite": { "node_modules/iconv-lite": {
"version": "0.6.3", "version": "0.6.3",
"resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
@@ -1062,6 +1231,18 @@
"@pkgjs/parseargs": "^0.11.0" "@pkgjs/parseargs": "^0.11.0"
} }
}, },
"node_modules/js-yaml": {
"version": "3.14.1",
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
"integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
"dependencies": {
"argparse": "^1.0.7",
"esprima": "^4.0.0"
},
"bin": {
"js-yaml": "bin/js-yaml.js"
}
},
"node_modules/jsdom": { "node_modules/jsdom": {
"version": "20.0.3", "version": "20.0.3",
"resolved": "https://registry.npmjs.org/jsdom/-/jsdom-20.0.3.tgz", "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-20.0.3.tgz",
@@ -1171,14 +1352,14 @@
} }
}, },
"node_modules/marked": { "node_modules/marked": {
"version": "4.3.0", "version": "5.0.2",
"resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", "resolved": "https://registry.npmjs.org/marked/-/marked-5.0.2.tgz",
"integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", "integrity": "sha512-TXksm9GwqXCRNbFUZmMtqNLvy3K2cQHuWmyBDLOrY1e6i9UvZpOTJXoz7fBjYkJkaUFzV9hBFxMuZSyQt8R6KQ==",
"bin": { "bin": {
"marked": "bin/marked.js" "marked": "bin/marked.js"
}, },
"engines": { "engines": {
"node": ">= 12" "node": ">= 18"
} }
}, },
"node_modules/mime-db": { "node_modules/mime-db": {
@@ -1215,11 +1396,11 @@
} }
}, },
"node_modules/minipass": { "node_modules/minipass": {
"version": "5.0.0", "version": "6.0.2",
"resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", "resolved": "https://registry.npmjs.org/minipass/-/minipass-6.0.2.tgz",
"integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", "integrity": "sha512-MzWSV5nYVT7mVyWCwn2o7JH13w2TBRmmSqSRCKzTw+lmft9X4z+3wjvs06Tzijo5z4W/kahUCDpRXTF+ZrmF/w==",
"engines": { "engines": {
"node": ">=8" "node": ">=16 || 14 >=14.17"
} }
}, },
"node_modules/ms": { "node_modules/ms": {
@@ -1274,11 +1455,12 @@
} }
}, },
"node_modules/nomnoml": { "node_modules/nomnoml": {
"version": "1.5.3", "version": "1.6.0",
"resolved": "https://registry.npmjs.org/nomnoml/-/nomnoml-1.5.3.tgz", "resolved": "https://registry.npmjs.org/nomnoml/-/nomnoml-1.6.0.tgz",
"integrity": "sha512-2LBKi3ygeYAC9l/wowgtBRxvQGuTryIczULVk2rFbWGUvs5aX68/sH+WgL95CschnSnxucTIv9L+3xScS71obQ==", "integrity": "sha512-+t3ZBx/yBBnvzQkVU0/pyXZNGHIyRdnPBg/8H7YvWBbvRroRG21amC2kZ1UVhGes2kU2cU6KjO4RSDgglajeQw==",
"dependencies": { "dependencies": {
"graphre": "^0.1.3" "graphre": "^0.1.3",
"nomnoml": "^1.5.3"
}, },
"bin": { "bin": {
"nomnoml": "dist/nomnoml-cli.js" "nomnoml": "dist/nomnoml-cli.js"
@@ -1366,12 +1548,12 @@
} }
}, },
"node_modules/path-scurry": { "node_modules/path-scurry": {
"version": "1.8.0", "version": "1.9.2",
"resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.8.0.tgz", "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.9.2.tgz",
"integrity": "sha512-IjTrKseM404/UAWA8bBbL3Qp6O2wXkanuIE3seCxBH7ctRuvH1QRawy1N3nVDHGkdeZsjOsSe/8AQBL/VQCy2g==", "integrity": "sha512-qSDLy2aGFPm8i4rsbHd4MNyTcrzHFsLQykrtbuGRknZZCBBVXSv2tSCDN2Cg6Rt/GFRw8GoW9y9Ecw5rIPG1sg==",
"dependencies": { "dependencies": {
"lru-cache": "^9.1.1", "lru-cache": "^9.1.1",
"minipass": "^5.0.0" "minipass": "^5.0.0 || ^6.0.2"
}, },
"engines": { "engines": {
"node": ">=16 || 14 >=14.17" "node": ">=16 || 14 >=14.17"
@@ -1479,6 +1661,16 @@
"resolved": "https://registry.npmjs.org/robust-predicates/-/robust-predicates-3.0.1.tgz", "resolved": "https://registry.npmjs.org/robust-predicates/-/robust-predicates-3.0.1.tgz",
"integrity": "sha512-ndEIpszUHiG4HtDsQLeIuMvRsDnn8c8rYStabochtUeCvfuvNptb5TUbVD68LRAILPX7p9nqQGh4xJgn3EHS/g==" "integrity": "sha512-ndEIpszUHiG4HtDsQLeIuMvRsDnn8c8rYStabochtUeCvfuvNptb5TUbVD68LRAILPX7p9nqQGh4xJgn3EHS/g=="
}, },
"node_modules/rrule": {
"version": "2.7.2",
"resolved": "https://registry.npmjs.org/rrule/-/rrule-2.7.2.tgz",
"integrity": "sha512-NkBsEEB6FIZOZ3T8frvEBOB243dm46SPufpDckY/Ap/YH24V1zLeMmDY8OA10lk452NdrF621+ynDThE7FQU2A==",
"optional": true,
"peer": true,
"dependencies": {
"tslib": "^2.4.0"
}
},
"node_modules/rw": { "node_modules/rw": {
"version": "1.3.3", "version": "1.3.3",
"resolved": "https://registry.npmjs.org/rw/-/rw-1.3.3.tgz", "resolved": "https://registry.npmjs.org/rw/-/rw-1.3.3.tgz",
@@ -1544,6 +1736,11 @@
"node": ">=0.10.0" "node": ">=0.10.0"
} }
}, },
"node_modules/sprintf-js": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
"integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g=="
},
"node_modules/string-width": { "node_modules/string-width": {
"version": "5.1.2", "version": "5.1.2",
"resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz",
@@ -1721,6 +1918,13 @@
"node": ">=12" "node": ">=12"
} }
}, },
"node_modules/tslib": {
"version": "2.5.2",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.2.tgz",
"integrity": "sha512-5svOrSA2w3iGFDs1HibEVBGbDrAY82bFQ3HZ3ixB+88nsbsWQoKqDRb5UBYAUPEzbBn6dAp5gRNXglySbx1MlA==",
"optional": true,
"peer": true
},
"node_modules/type-check": { "node_modules/type-check": {
"version": "0.3.2", "version": "0.3.2",
"resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz",
@@ -1770,6 +1974,11 @@
"requires-port": "^1.0.0" "requires-port": "^1.0.0"
} }
}, },
"node_modules/uuid-random": {
"version": "1.3.2",
"resolved": "https://registry.npmjs.org/uuid-random/-/uuid-random-1.3.2.tgz",
"integrity": "sha512-UOzej0Le/UgkbWEO8flm+0y+G+ljUon1QWTEZOq1rnMAsxo2+SckbiZdKzAHHlVh6gJqI1TjC/xwgR50MuCrBQ=="
},
"node_modules/vega": { "node_modules/vega": {
"version": "5.25.0", "version": "5.25.0",
"resolved": "https://registry.npmjs.org/vega/-/vega-5.25.0.tgz", "resolved": "https://registry.npmjs.org/vega/-/vega-5.25.0.tgz",
@@ -2360,6 +2569,20 @@
"node": ">=12" "node": ">=12"
} }
}, },
"node_modules/xmlbuilder2": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/xmlbuilder2/-/xmlbuilder2-3.1.1.tgz",
"integrity": "sha512-WCSfbfZnQDdLQLiMdGUQpMxxckeQ4oZNMNhLVkcekTu7xhD4tuUDyAPoY8CwXvBYE6LwBHd6QW2WZXlOWr1vCw==",
"dependencies": {
"@oozcitak/dom": "1.15.10",
"@oozcitak/infra": "1.0.8",
"@oozcitak/util": "8.3.8",
"js-yaml": "3.14.1"
},
"engines": {
"node": ">=12.0"
}
},
"node_modules/xmlchars": { "node_modules/xmlchars": {
"version": "2.2.0", "version": "2.2.0",
"resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz",
@@ -2469,15 +2692,15 @@
} }
}, },
"@doc-utils/markdown2html": { "@doc-utils/markdown2html": {
"version": "0.1.21", "version": "0.2.6",
"resolved": "https://gitea.jbrumond.me/api/packages/doc-utils/npm/%40doc-utils%2Fmarkdown2html/-/0.1.21/markdown2html-0.1.21.tgz", "resolved": "https://gitea.jbrumond.me/api/packages/doc-utils/npm/%40doc-utils%2Fmarkdown2html/-/0.2.6/markdown2html-0.2.6.tgz",
"integrity": "sha512-yoyWrOOm4NNvxvzGn0oFwGgJb8xwmdQcAzgvN2s+xIC2sVL1WBirOlM+iJ1pOhXfAiKEPqzgEim+SE74siWp9Q==", "integrity": "sha512-6cQNzthYOOlkT6rr6E1lpSJ4Zq991+chblSRxv69SVT8y5cIs6c9tFu75MXoIKX4+H68Q4i10gtMrrsXD+bkaA==",
"requires": { "requires": {
"bytefield-svg": "^1.6.1", "bytefield-svg": "^1.6.1",
"dompurify": "^2.3.6", "dompurify": "^2.3.6",
"jsdom": "^20.0.1", "jsdom": "^20.0.1",
"katex": "^0.16.7", "katex": "^0.16.7",
"marked": "^4.1.1", "marked": "^5.0.2",
"nomnoml": "^1.5.2", "nomnoml": "^1.5.2",
"pikchr": "^0.0.5", "pikchr": "^0.0.5",
"prismjs": "^1.29.0", "prismjs": "^1.29.0",
@@ -2499,6 +2722,38 @@
"wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0"
} }
}, },
"@oozcitak/dom": {
"version": "1.15.10",
"resolved": "https://registry.npmjs.org/@oozcitak/dom/-/dom-1.15.10.tgz",
"integrity": "sha512-0JT29/LaxVgRcGKvHmSrUTEvZ8BXvZhGl2LASRUgHqDTC1M5g1pLmVv56IYNyt3bG2CUjDkc67wnyZC14pbQrQ==",
"requires": {
"@oozcitak/infra": "1.0.8",
"@oozcitak/url": "1.0.4",
"@oozcitak/util": "8.3.8"
}
},
"@oozcitak/infra": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/@oozcitak/infra/-/infra-1.0.8.tgz",
"integrity": "sha512-JRAUc9VR6IGHOL7OGF+yrvs0LO8SlqGnPAMqyzOuFZPSZSXI7Xf2O9+awQPSMXgIWGtgUf/dA6Hs6X6ySEaWTg==",
"requires": {
"@oozcitak/util": "8.3.8"
}
},
"@oozcitak/url": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/@oozcitak/url/-/url-1.0.4.tgz",
"integrity": "sha512-kDcD8y+y3FCSOvnBI6HJgl00viO/nGbQoCINmQ0h98OhnGITrWR3bOGfwYCthgcrV8AnTJz8MzslTQbC3SOAmw==",
"requires": {
"@oozcitak/infra": "1.0.8",
"@oozcitak/util": "8.3.8"
}
},
"@oozcitak/util": {
"version": "8.3.8",
"resolved": "https://registry.npmjs.org/@oozcitak/util/-/util-8.3.8.tgz",
"integrity": "sha512-T8TbSnGsxo6TDBJx/Sgv/BlVJL3tshxZP7Aq5R1mSnM5OcHY2dQaxLMu2+E8u3gN0MLOzdjurqN4ZRVuzQycOQ=="
},
"@pkgjs/parseargs": { "@pkgjs/parseargs": {
"version": "0.11.0", "version": "0.11.0",
"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
@@ -2520,6 +2775,40 @@
"resolved": "https://registry.npmjs.org/@types/geojson/-/geojson-7946.0.4.tgz", "resolved": "https://registry.npmjs.org/@types/geojson/-/geojson-7946.0.4.tgz",
"integrity": "sha512-MHmwBtCb7OCv1DSivz2UNJXPGU/1btAWRKlqJ2saEhVJkpkvqHMMaOpKg0v4sAbDWSQekHGvPVMM8nQ+Jen03Q==" "integrity": "sha512-MHmwBtCb7OCv1DSivz2UNJXPGU/1btAWRKlqJ2saEhVJkpkvqHMMaOpKg0v4sAbDWSQekHGvPVMM8nQ+Jen03Q=="
}, },
"@types/ical": {
"version": "0.8.0",
"resolved": "https://registry.npmjs.org/@types/ical/-/ical-0.8.0.tgz",
"integrity": "sha512-46KAYxAwRuCh+jRgl9k5cTaXJJkB16gWpvMVPuog9UBBb2zXTf9M0MsfWYBQ21JohFSuMZfPTvk6tohqGr1tCg==",
"dev": true,
"requires": {
"rrule": "2.6.4"
},
"dependencies": {
"luxon": {
"version": "1.28.1",
"resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.1.tgz",
"integrity": "sha512-gYHAa180mKrNIUJCbwpmD0aTu9kV0dREDrwNnuyFAsO1Wt0EVYSZelPnJlbj9HplzXX/YWXHFTL45kvZ53M0pw==",
"dev": true,
"optional": true
},
"rrule": {
"version": "2.6.4",
"resolved": "https://registry.npmjs.org/rrule/-/rrule-2.6.4.tgz",
"integrity": "sha512-sLdnh4lmjUqq8liFiOUXD5kWp/FcnbDLPwq5YAc/RrN6120XOPb86Ae5zxF7ttBVq8O3LxjjORMEit1baluahA==",
"dev": true,
"requires": {
"luxon": "^1.21.3",
"tslib": "^1.10.0"
}
},
"tslib": {
"version": "1.14.1",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
"integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==",
"dev": true
}
}
},
"@types/jsdom": { "@types/jsdom": {
"version": "20.0.1", "version": "20.0.1",
"resolved": "https://registry.npmjs.org/@types/jsdom/-/jsdom-20.0.1.tgz", "resolved": "https://registry.npmjs.org/@types/jsdom/-/jsdom-20.0.1.tgz",
@@ -2535,7 +2824,7 @@
"version": "3.3.0", "version": "3.3.0",
"resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-3.3.0.tgz", "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-3.3.0.tgz",
"integrity": "sha512-uKRI5QORDnrGFYgcdAVnHvEIvEZ8noTpP/Bg+HeUzZghwinDlIS87DEenV5r1YoOF9G4x600YsUXLWZ19rmTmg==", "integrity": "sha512-uKRI5QORDnrGFYgcdAVnHvEIvEZ8noTpP/Bg+HeUzZghwinDlIS87DEenV5r1YoOF9G4x600YsUXLWZ19rmTmg==",
"dev": true "devOptional": true
}, },
"@types/mustache": { "@types/mustache": {
"version": "4.2.2", "version": "4.2.2",
@@ -2544,10 +2833,10 @@
"dev": true "dev": true
}, },
"@types/node": { "@types/node": {
"version": "18.16.9", "version": "18.16.13",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.9.tgz", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.13.tgz",
"integrity": "sha512-IeB32oIV4oGArLrd7znD2rkHQ6EDCM+2Sr76dJnrHwv9OHBTTM6nuDLK9bmikXzPa0ZlWMWtRGo/Uw4mrzQedA==", "integrity": "sha512-uZRomboV1vBL61EBXneL4j9/hEn+1Yqa4LQdpGrKmXFyJmVfWc9JV9+yb2AlnOnuaDnb2PDO3hC6/LKmzJxP1A==",
"dev": true "devOptional": true
}, },
"@types/prismjs": { "@types/prismjs": {
"version": "1.26.0", "version": "1.26.0",
@@ -2606,6 +2895,14 @@
"color-convert": "^1.9.0" "color-convert": "^1.9.0"
} }
}, },
"argparse": {
"version": "1.0.10",
"resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
"integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
"requires": {
"sprintf-js": "~1.0.2"
}
},
"array-back": { "array-back": {
"version": "3.1.0", "version": "3.1.0",
"resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz",
@@ -3134,14 +3431,14 @@
"integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==" "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg=="
}, },
"glob": { "glob": {
"version": "10.2.3", "version": "10.2.5",
"resolved": "https://registry.npmjs.org/glob/-/glob-10.2.3.tgz", "resolved": "https://registry.npmjs.org/glob/-/glob-10.2.5.tgz",
"integrity": "sha512-Kb4rfmBVE3eQTAimgmeqc2LwSnN0wIOkkUL6HmxEFxNJ4fHghYHVbFba/HcGcRjE6s9KoMNK3rSOwkL4PioZjg==", "integrity": "sha512-Gj+dFYPZ5hc5dazjXzB0iHg2jKWJZYMjITXYPBRQ/xc2Buw7H0BINknRTwURJ6IC6MEFpYbLvtgVb3qD+DwyuA==",
"requires": { "requires": {
"foreground-child": "^3.1.0", "foreground-child": "^3.1.0",
"jackspeak": "^2.0.3", "jackspeak": "^2.0.3",
"minimatch": "^9.0.0", "minimatch": "^9.0.0",
"minipass": "^5.0.0", "minipass": "^5.0.0 || ^6.0.2",
"path-scurry": "^1.7.0" "path-scurry": "^1.7.0"
} }
}, },
@@ -3182,6 +3479,38 @@
"debug": "4" "debug": "4"
} }
}, },
"ical": {
"version": "0.8.0",
"resolved": "https://registry.npmjs.org/ical/-/ical-0.8.0.tgz",
"integrity": "sha512-/viUSb/RGLLnlgm0lWRlPBtVeQguQRErSPYl3ugnUaKUnzQswKqOG3M8/P1v1AB5NJwlHTuvTq1cs4mpeG2rCg==",
"requires": {
"rrule": "2.4.1"
},
"dependencies": {
"luxon": {
"version": "1.28.1",
"resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.1.tgz",
"integrity": "sha512-gYHAa180mKrNIUJCbwpmD0aTu9kV0dREDrwNnuyFAsO1Wt0EVYSZelPnJlbj9HplzXX/YWXHFTL45kvZ53M0pw==",
"optional": true
},
"rrule": {
"version": "2.4.1",
"resolved": "https://registry.npmjs.org/rrule/-/rrule-2.4.1.tgz",
"integrity": "sha512-+NcvhETefswZq13T8nkuEnnQ6YgUeZaqMqVbp+ZiFDPCbp3AVgQIwUvNVDdMNrP05bKZG9ddDULFp0qZZYDrxg==",
"requires": {
"luxon": "^1.3.3"
}
}
}
},
"ical-generator": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/ical-generator/-/ical-generator-4.1.0.tgz",
"integrity": "sha512-5GrFDJ8SAOj8cB9P1uEZIfKrNxSZ1R2eOQfZePL+CtdWh4RwNXWe8b0goajz+Hu37vcipG3RVldoa2j57Y20IA==",
"requires": {
"uuid-random": "^1.3.2"
}
},
"iconv-lite": { "iconv-lite": {
"version": "0.6.3", "version": "0.6.3",
"resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
@@ -3219,6 +3548,15 @@
"@pkgjs/parseargs": "^0.11.0" "@pkgjs/parseargs": "^0.11.0"
} }
}, },
"js-yaml": {
"version": "3.14.1",
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
"integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
"requires": {
"argparse": "^1.0.7",
"esprima": "^4.0.0"
}
},
"jsdom": { "jsdom": {
"version": "20.0.3", "version": "20.0.3",
"resolved": "https://registry.npmjs.org/jsdom/-/jsdom-20.0.3.tgz", "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-20.0.3.tgz",
@@ -3298,9 +3636,9 @@
"integrity": "sha512-An0UCfG/rSiqtAIiBPO0Y9/zAnHUZxAMiCpTd5h2smgsj7GGmcenvrvww2cqNA8/4A5ZrD1gJpHN2mIHZQF+Mg==" "integrity": "sha512-An0UCfG/rSiqtAIiBPO0Y9/zAnHUZxAMiCpTd5h2smgsj7GGmcenvrvww2cqNA8/4A5ZrD1gJpHN2mIHZQF+Mg=="
}, },
"marked": { "marked": {
"version": "4.3.0", "version": "5.0.2",
"resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", "resolved": "https://registry.npmjs.org/marked/-/marked-5.0.2.tgz",
"integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==" "integrity": "sha512-TXksm9GwqXCRNbFUZmMtqNLvy3K2cQHuWmyBDLOrY1e6i9UvZpOTJXoz7fBjYkJkaUFzV9hBFxMuZSyQt8R6KQ=="
}, },
"mime-db": { "mime-db": {
"version": "1.52.0", "version": "1.52.0",
@@ -3324,9 +3662,9 @@
} }
}, },
"minipass": { "minipass": {
"version": "5.0.0", "version": "6.0.2",
"resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", "resolved": "https://registry.npmjs.org/minipass/-/minipass-6.0.2.tgz",
"integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==" "integrity": "sha512-MzWSV5nYVT7mVyWCwn2o7JH13w2TBRmmSqSRCKzTw+lmft9X4z+3wjvs06Tzijo5z4W/kahUCDpRXTF+ZrmF/w=="
}, },
"ms": { "ms": {
"version": "2.1.2", "version": "2.1.2",
@@ -3368,11 +3706,12 @@
} }
}, },
"nomnoml": { "nomnoml": {
"version": "1.5.3", "version": "1.6.0",
"resolved": "https://registry.npmjs.org/nomnoml/-/nomnoml-1.5.3.tgz", "resolved": "https://registry.npmjs.org/nomnoml/-/nomnoml-1.6.0.tgz",
"integrity": "sha512-2LBKi3ygeYAC9l/wowgtBRxvQGuTryIczULVk2rFbWGUvs5aX68/sH+WgL95CschnSnxucTIv9L+3xScS71obQ==", "integrity": "sha512-+t3ZBx/yBBnvzQkVU0/pyXZNGHIyRdnPBg/8H7YvWBbvRroRG21amC2kZ1UVhGes2kU2cU6KjO4RSDgglajeQw==",
"requires": { "requires": {
"graphre": "^0.1.3" "graphre": "^0.1.3",
"nomnoml": "^1.5.3"
} }
}, },
"nwsapi": { "nwsapi": {
@@ -3433,12 +3772,12 @@
"integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==" "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="
}, },
"path-scurry": { "path-scurry": {
"version": "1.8.0", "version": "1.9.2",
"resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.8.0.tgz", "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.9.2.tgz",
"integrity": "sha512-IjTrKseM404/UAWA8bBbL3Qp6O2wXkanuIE3seCxBH7ctRuvH1QRawy1N3nVDHGkdeZsjOsSe/8AQBL/VQCy2g==", "integrity": "sha512-qSDLy2aGFPm8i4rsbHd4MNyTcrzHFsLQykrtbuGRknZZCBBVXSv2tSCDN2Cg6Rt/GFRw8GoW9y9Ecw5rIPG1sg==",
"requires": { "requires": {
"lru-cache": "^9.1.1", "lru-cache": "^9.1.1",
"minipass": "^5.0.0" "minipass": "^5.0.0 || ^6.0.2"
} }
}, },
"pikchr": { "pikchr": {
@@ -3515,6 +3854,16 @@
"resolved": "https://registry.npmjs.org/robust-predicates/-/robust-predicates-3.0.1.tgz", "resolved": "https://registry.npmjs.org/robust-predicates/-/robust-predicates-3.0.1.tgz",
"integrity": "sha512-ndEIpszUHiG4HtDsQLeIuMvRsDnn8c8rYStabochtUeCvfuvNptb5TUbVD68LRAILPX7p9nqQGh4xJgn3EHS/g==" "integrity": "sha512-ndEIpszUHiG4HtDsQLeIuMvRsDnn8c8rYStabochtUeCvfuvNptb5TUbVD68LRAILPX7p9nqQGh4xJgn3EHS/g=="
}, },
"rrule": {
"version": "2.7.2",
"resolved": "https://registry.npmjs.org/rrule/-/rrule-2.7.2.tgz",
"integrity": "sha512-NkBsEEB6FIZOZ3T8frvEBOB243dm46SPufpDckY/Ap/YH24V1zLeMmDY8OA10lk452NdrF621+ynDThE7FQU2A==",
"optional": true,
"peer": true,
"requires": {
"tslib": "^2.4.0"
}
},
"rw": { "rw": {
"version": "1.3.3", "version": "1.3.3",
"resolved": "https://registry.npmjs.org/rw/-/rw-1.3.3.tgz", "resolved": "https://registry.npmjs.org/rw/-/rw-1.3.3.tgz",
@@ -3562,6 +3911,11 @@
"integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
"optional": true "optional": true
}, },
"sprintf-js": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
"integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g=="
},
"string-width": { "string-width": {
"version": "5.1.2", "version": "5.1.2",
"resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz",
@@ -3695,6 +4049,13 @@
"punycode": "^2.1.1" "punycode": "^2.1.1"
} }
}, },
"tslib": {
"version": "2.5.2",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.2.tgz",
"integrity": "sha512-5svOrSA2w3iGFDs1HibEVBGbDrAY82bFQ3HZ3ixB+88nsbsWQoKqDRb5UBYAUPEzbBn6dAp5gRNXglySbx1MlA==",
"optional": true,
"peer": true
},
"type-check": { "type-check": {
"version": "0.3.2", "version": "0.3.2",
"resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz",
@@ -3728,6 +4089,11 @@
"requires-port": "^1.0.0" "requires-port": "^1.0.0"
} }
}, },
"uuid-random": {
"version": "1.3.2",
"resolved": "https://registry.npmjs.org/uuid-random/-/uuid-random-1.3.2.tgz",
"integrity": "sha512-UOzej0Le/UgkbWEO8flm+0y+G+ljUon1QWTEZOq1rnMAsxo2+SckbiZdKzAHHlVh6gJqI1TjC/xwgR50MuCrBQ=="
},
"vega": { "vega": {
"version": "5.25.0", "version": "5.25.0",
"resolved": "https://registry.npmjs.org/vega/-/vega-5.25.0.tgz", "resolved": "https://registry.npmjs.org/vega/-/vega-5.25.0.tgz",
@@ -4239,6 +4605,17 @@
"resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-4.0.0.tgz", "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-4.0.0.tgz",
"integrity": "sha512-ICP2e+jsHvAj2E2lIHxa5tjXRlKDJo4IdvPvCXbXQGdzSfmSpNVyIKMvoZHjDY9DP0zV17iI85o90vRFXNccRw==" "integrity": "sha512-ICP2e+jsHvAj2E2lIHxa5tjXRlKDJo4IdvPvCXbXQGdzSfmSpNVyIKMvoZHjDY9DP0zV17iI85o90vRFXNccRw=="
}, },
"xmlbuilder2": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/xmlbuilder2/-/xmlbuilder2-3.1.1.tgz",
"integrity": "sha512-WCSfbfZnQDdLQLiMdGUQpMxxckeQ4oZNMNhLVkcekTu7xhD4tuUDyAPoY8CwXvBYE6LwBHd6QW2WZXlOWr1vCw==",
"requires": {
"@oozcitak/dom": "1.15.10",
"@oozcitak/infra": "1.0.8",
"@oozcitak/util": "8.3.8",
"js-yaml": "3.14.1"
}
},
"xmlchars": { "xmlchars": {
"version": "2.2.0", "version": "2.2.0",
"resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz",

View File

@@ -1,6 +1,6 @@
{ {
"name": "@doc-utils/docs2website", "name": "@doc-utils/docs2website",
"version": "0.1.1", "version": "0.1.4",
"publishConfig": { "publishConfig": {
"registry": "https://gitea.home.jbrumond.me/api/packages/doc-utils/npm/" "registry": "https://gitea.home.jbrumond.me/api/packages/doc-utils/npm/"
}, },
@@ -13,6 +13,7 @@
}, },
"main": "./build/index.js", "main": "./build/index.js",
"devDependencies": { "devDependencies": {
"@types/ical": "^0.8.0",
"@types/jsdom": "^20.0.1", "@types/jsdom": "^20.0.1",
"@types/luxon": "^3.3.0", "@types/luxon": "^3.3.0",
"@types/mustache": "^4.2.2", "@types/mustache": "^4.2.2",
@@ -23,10 +24,13 @@
"dependencies": { "dependencies": {
"@doc-utils/color-themes": "^0.1.14", "@doc-utils/color-themes": "^0.1.14",
"@doc-utils/jsonschema2markdown": "^0.1.1", "@doc-utils/jsonschema2markdown": "^0.1.1",
"@doc-utils/markdown2html": "^0.1.21", "@doc-utils/markdown2html": "^0.2.1",
"glob": "^10.2.3", "glob": "^10.2.3",
"ical": "^0.8.0",
"ical-generator": "^4.1.0",
"luxon": "^3.3.0", "luxon": "^3.3.0",
"mustache": "^4.2.0", "mustache": "^4.2.0",
"xmlbuilder2": "^3.1.1",
"yaml": "^2.2.2" "yaml": "^2.2.2"
} }
} }

View File

@@ -1,6 +1,6 @@
import { read_config } from '../conf'; import { read_config } from '../conf';
import { build_docs_project } from '../build'; import { build_docs_project } from '../build-files';
main(); main();

304
src/build-files/helpers.ts Normal file
View File

@@ -0,0 +1,304 @@
import { dirname, join as path_join } from 'path';
import { icons } from '../icons';
import { BuildState } from './state';
import { mkdirp, write_text } from '../fs';
import { CalendarConfig, RSSConfig } from '../conf';
import { render_theme_css_properties } from '../themes';
import { load_partials, FrontMatter, Context, load_layout, render_template } from '../template';
import { render_markdown_to_html, render_markdown_to_html_inline_sync } from '@doc-utils/markdown2html';
import { RSSEntry } from './rss';
import { DateTime } from 'luxon';
import { EventEntry } from './icalendar';
export interface OutFileURL {
base_url: string;
rel_path: string;
dir_url: string;
abs_url: string;
}
export function map_output_file_to_url(state: BuildState, out_file: string, index_file?: string) : OutFileURL {
let rel_path = out_file.slice(state.conf.input.root.length);
if (index_file && rel_path.endsWith('/' + index_file)) {
rel_path = rel_path.slice(0, -(index_file.length + 1));
}
if (! rel_path.startsWith('/')) {
rel_path = '/' + rel_path;
}
const base_url = state.conf.base_url.endsWith('/')
? state.conf.base_url.slice(0, -1)
: state.conf.base_url;
return {
base_url,
rel_path,
dir_url: base_url + dirname(rel_path),
abs_url: base_url + rel_path
};
}
export async function map_input_file_to_output_file(state: BuildState, in_file: string, remove_exts?: string[], add_ext?: string) {
if (! in_file.startsWith(state.conf.input.root)) {
throw new Error('input file expected to be inside input root');
}
let out_file = path_join(state.conf.output.root, in_file.slice(state.conf.input.root.length));
if (remove_exts) {
for (const ext of remove_exts) {
if (out_file.endsWith(ext)) {
out_file = out_file.slice(0, -ext.length);
break;
}
}
}
if (add_ext) {
out_file += add_ext;
}
const dir = dirname(out_file);
if (! state.made_directories.has(dir)) {
state.made_directories.add(dir);
await mkdirp(dir);
}
return out_file;
}
export async function build_partials(state: BuildState) {
state.partials = await load_partials(state.conf);
for (const [name, theme] of Object.entries(state.themes)) {
state.partials[`.themes/${name}`] = render_theme_css_properties(theme);
}
Object.assign(state.partials, state.extras);
}
export function mustache_context(state: BuildState, page_url: string, frontmatter?: FrontMatter) : Context {
return {
env: state.env,
page: frontmatter,
base_url: state.conf.base_url,
page_url: page_url,
site_title: state.conf.title,
author: get_author(state, frontmatter),
build_time: state.build_time,
icons: icons,
rss_feeds: state.conf.rss || [ ],
calendars: state.conf.calendars || [ ],
themes: Object.values(state.themes),
theme_groups: structuredClone(state.theme_groups),
markdown: {
render_inline() {
return (text, render) => {
const md = render(text)
const html = render_markdown_to_html_inline_sync(md,
Object.assign({ }, state.conf.markdown, { base_url: page_url })
);
return html;
};
},
}
};
}
export async function render_page(state: BuildState, in_file: string, out_file: string, out_url: OutFileURL, text: string, render_as_markdown: boolean, frontmatter?: any) {
if (render_as_markdown) {
const opts = Object.assign({ }, state.conf.markdown, {
base_url: out_url.abs_url
});
text = await render_markdown_to_html(text, opts);
}
let layout: string;
const layout_file = frontmatter?.layout;
if (layout_file) {
if (! state.layouts[layout_file]) {
state.layouts[layout_file] = await load_layout(state.conf, layout_file);
}
layout = state.layouts[layout_file];
}
const tags = state.conf.templates?.tags;
const context = mustache_context(state, out_url.abs_url, frontmatter);
const rendered = render_template(text, context, layout, structuredClone(state.partials), tags);
await write_text(out_file, rendered);
handle_page_side_effects(state, in_file, out_file, out_url, text, frontmatter);
}
function handle_page_side_effects(state: BuildState, in_file: string, out_file: string, out_url: OutFileURL, text: string, frontmatter?: any) {
// Only actual HTML webpages are registered with things like the RSS feed; This is
// to prevent things like CSS files showing up, which may be templated (and therefore
// pass through this function), but are not really "pages"
if (frontmatter && typeof frontmatter === 'object' && out_file.endsWith('.html')) {
if (state.conf.rss) {
for (const [index, rss_conf] of Object.entries(state.conf.rss)) {
if (in_file.startsWith(rss_conf.in_dir + '/')) {
const entries = (state.rss[index] = state.rss[index] || [ ]);
handle_rss(state, rss_conf, entries, in_file, out_url, text, frontmatter);
}
}
}
if (state.conf.sitemap) {
handle_sitemap(state, out_url, frontmatter);
}
if (frontmatter?.event) {
if (state.conf.events) {
handle_event(state, in_file, out_url, frontmatter);
}
if (state.conf.calendars) {
for (const [index, cal_conf] of Object.entries(state.conf.calendars)) {
if (in_file.startsWith(cal_conf.in_dir + '/')) {
const entries = (state.rss[index] = state.rss[index] || [ ]);
handle_calendar(state, cal_conf, entries, in_file, out_url, frontmatter);
}
}
}
}
}
}
function handle_rss(state: BuildState, rss_conf: RSSConfig, entries: RSSEntry[], in_file: string, out_url: OutFileURL, text: string, frontmatter: FrontMatter) {
const author_or_authors = get_author(state, frontmatter);
const author = Array.isArray(author_or_authors) ? author_or_authors[0] : author_or_authors;
entries.push({
url: out_url.abs_url,
in_file: in_file,
html_content: text,
title: frontmatter?.title,
description: frontmatter?.description,
author_name: author?.name,
tags: frontmatter?.tags,
});
}
function handle_sitemap(state: BuildState, out_url: OutFileURL, frontmatter: FrontMatter) {
state.sitemap.push({
url: out_url.abs_url,
lastmod: state.build_time.iso,
change_freq: frontmatter?.sitemap?.change_freq,
priority: frontmatter?.sitemap?.priority,
});
}
function handle_event(state: BuildState, in_file: string, out_url: OutFileURL, frontmatter: FrontMatter) {
if (! state.conf.events) {
return;
}
const author_or_authors = get_author(state, frontmatter);
const author = Array.isArray(author_or_authors) ? author_or_authors[0] : author_or_authors;
state.events.push({
url: out_url.abs_url,
in_file: in_file,
title: frontmatter.title,
description: frontmatter.description,
author_name: author?.name,
author_email: author?.email,
start_time: frontmatter.event?.start_time,
end_time: frontmatter.event?.end_time,
time_zone: frontmatter.event?.time_zone,
});
}
function handle_calendar(state: BuildState, cal_conf: CalendarConfig, entries: EventEntry[], in_file: string, out_url: OutFileURL, frontmatter: FrontMatter) {
const author_or_authors = get_author(state, frontmatter);
const author = Array.isArray(author_or_authors) ? author_or_authors[0] : author_or_authors;
entries.push({
url: out_url.abs_url,
in_file: in_file,
title: frontmatter.title,
description: frontmatter.description,
author_name: author?.name,
author_email: author?.email,
start_time: frontmatter.event?.start_time,
end_time: frontmatter.event?.end_time,
time_zone: frontmatter.event?.time_zone,
});
}
export function config_hash_matches(state: BuildState) {
const { old_metadata, new_metadata } = state;
if (! old_metadata.last_build?.config_hash) {
return false;
}
if (old_metadata.last_build.config_hash !== new_metadata.last_build.config_hash) {
return false;
}
return true;
}
export function file_hash_matches(state: BuildState, in_file: string, new_hash: string) {
in_file = in_file.slice(state.conf.input.root.length);
const old_hash = state.old_metadata.files[in_file]?.last_build_hash;
if (! old_hash) {
return false;
}
if (old_hash !== new_hash) {
return false;
}
return true;
}
export function skip_file(state: BuildState, in_file: string, out_file: string, out_url: OutFileURL, frontmatter?: any) {
in_file = in_file.slice(state.conf.input.root.length);
state.new_metadata.files[in_file] = structuredClone(state.old_metadata?.files?.[in_file]);
handle_page_side_effects(state, in_file, out_file, out_url, frontmatter);
}
export function copy_metadata(state: BuildState, in_file: string) {
in_file = in_file.slice(state.conf.input.root.length);
state.new_metadata.files[in_file] = structuredClone(state.old_metadata?.files?.[in_file]);
}
export function update_metadata(state: BuildState, in_file: string, hash: string) {
in_file = in_file.slice(state.conf.input.root.length);
state.new_metadata.files[in_file] = {
first_seen_time: state.old_metadata?.files?.[in_file]?.first_seen_time || state.build_time.iso,
last_build_hash: hash,
last_updated_time: state.build_time.iso,
};
}
export function get_author(state: BuildState, frontmatter?: FrontMatter) {
if (! frontmatter?.author) {
return null;
}
if (Array.isArray(frontmatter.author)) {
const list = frontmatter.author
.map((author) => state.conf.authors?.[author])
.filter((author) => author);
if (! list.length) {
return null;
}
return list;
}
return state.conf.authors?.[frontmatter.author]
}

View File

@@ -0,0 +1,131 @@
import { write_text } from '../fs';
import { BuildState } from './state';
import { map_input_file_to_output_file } from './helpers';
import { parseICS, CalendarComponent } from 'ical';
import create_calendar, { ICalEventData, ICalCalendarData } from 'ical-generator';
export type { ICalEventData, ICalCalendarData, ICalAttendeeData, ICalAttendeeStatus } from 'ical-generator';
export interface EventEntry {
url: string;
in_file: string;
title?: string;
description?: string;
author_name?: string;
author_email?: string;
start_time?: string;
end_time?: string;
time_zone?: `${string}/${string}`;
}
export async function write_events_and_calendars_if_needed(state: BuildState) {
if (state.conf.events) {
for (const entry of state.events) {
const event = icalendar_event(state, entry);
const cal_data: ICalCalendarData = {
prodId: {
company: 'jbrumond.me',
product: 'docs2website',
language: 'EN',
},
// ...
};
const calendar = create_icalendar(cal_data, event);
const out_file = await map_input_file_to_output_file(state, entry.in_file, [ '.html', '.md', '.markdown' ], '.isc');
await write_text(out_file, calendar);
}
}
if (state.conf.calendars) {
for (let index = 0; index < state.conf.calendars.length; index++) {
const cal_conf = state.conf.calendars[index];
const cal_entries = state.calendars[index];
for (const entry of cal_entries) {
const event = icalendar_event(state, entry);
const cal_data: ICalCalendarData = {
name: cal_conf.title,
prodId: {
company: 'jbrumond.me',
product: 'docs2website',
language: 'EN',
},
// ...
};
const calendar = create_icalendar(cal_data, event);
await write_text(cal_conf.out_file, calendar);
}
}
}
}
export function parse_icalendar(contents: string) {
const parsed = parseICS(contents);
const calendar: CalendarComponent[] = [ ];
for (const data of Object.values(parsed)) {
calendar.push(data);
}
return calendar;
}
export function create_icalendar(cal: ICalCalendarData, events: ICalEventData | ICalEventData[]) {
const calendar = create_calendar(cal);
if (Array.isArray(events)) {
for (const event of events) {
calendar.createEvent(event);
}
}
else {
calendar.createEvent(events);
}
return calendar.toString();
}
export function icalendar_event(state: BuildState, entry: EventEntry) : ICalEventData {
const in_file = entry.in_file.slice(state.conf.input.root.length);
const metadata = state.new_metadata.files[in_file];
return {
id: entry.url,
summary: entry.title,
description: entry.description || void 0,
start: entry.start_time,
end: entry.end_time,
url: entry.url,
timezone: entry.time_zone,
created: metadata.first_seen_time,
lastModified: metadata.last_updated_time,
organizer: {
name: entry.author_name || 'Unknown',
email: entry.author_email,
},
// attendees: post.mentions.flatMap((mention) : ICalAttendeeData | ICalAttendeeData[] => {
// if (mention.is_rsvp && mention.is_reply_to_this) {
// const ext = mention.external as ExternalEntry;
// const status = ext.rsvp_type === 'yes'
// ? 'ACCEPTED' as const
// : ext.rsvp_type === 'no'
// ? 'DECLINED' as const
// : ext.rsvp_type === 'maybe'
// ? 'TENTATIVE' as const
// : 'NEEDS-ACTION' as const;
// return {
// name: mention.author_name,
// rsvp: ext.rsvp_type === 'yes',
// status: status as ICalAttendeeStatus
// };
// }
// return [ ];
// }),
};
}

101
src/build-files/index.ts Normal file
View File

@@ -0,0 +1,101 @@
import { DateTime } from 'luxon';
import { Config } from '../conf';
import { build_env_scope } from '../env';
import { load_themes } from '../themes';
import { load_extras } from '../template';
import { Metadata } from '../metadata';
import { hash_obj } from '../hash';
import { BuildState } from './state';
import { read_json, with_default_if_missing, write_json } from '../fs';
import { copy_raw_files } from './raw';
import { render_text_file_templates } from './mustache';
import { render_markdown_files } from './markdown';
import { render_json_schema_files } from './jsonschema';
import { write_sitemap_if_needed } from './sitemap';
import { write_rss_if_needed } from './rss';
import { write_events_and_calendars_if_needed } from './icalendar';
export { BuildState, ThemeGroups } from './state';
export async function build_docs_project(conf: Config) {
const now = DateTime.now();
const conf_hash = hash_obj(conf);
const themes = await load_themes(conf);
const get_metadata = read_json(conf.metadata, false).then(({ parsed }) => parsed);
const metadata = await with_default_if_missing<Metadata>(get_metadata, {
last_build: null,
files: { },
});
const state: BuildState = {
conf,
seen_files: new Set<string>(),
env: build_env_scope(conf),
layouts: Object.create(null),
themes: themes,
theme_groups: {
all: Object.values(themes),
light: [ ],
dark: [ ],
high_contrast: [ ],
low_contrast: [ ],
monochrome: [ ],
greyscale: [ ],
protanopia_safe: [ ],
deuteranopia_safe: [ ],
tritanopia_safe: [ ],
},
old_metadata: metadata,
new_metadata: {
last_build: {
time: now.toISO(),
config_hash: conf_hash,
},
files: { }
},
extras: await load_extras(),
made_directories: new Set<string>(),
rss: [ ],
sitemap: [ ],
events: [ ],
calendars: [ ],
build_time: {
iso: now.toISO(),
rfc2822: now.toRFC2822(),
},
};
for (const theme of Object.values(themes)) {
for (const label of theme.labels) {
state.theme_groups[label].push(theme);
}
}
if (conf.input.raw) {
await copy_raw_files(state);
}
if (conf.input.text) {
await render_text_file_templates(state);
}
if (conf.input.markdown) {
await render_markdown_files(state);
}
if (conf.input['schema+json'] || conf.input['schema+yaml']) {
await render_json_schema_files(state);
}
// todo: other file types...
await write_sitemap_if_needed(state);
await write_rss_if_needed(state);
await write_events_and_calendars_if_needed(state);
// Write the updated metadata file
await write_json(conf.metadata, state.new_metadata, true);
}

View File

@@ -0,0 +1,137 @@
import { glob } from 'glob';
import { BuildState } from './state';
import { read_json, write_text, read_yaml } from '../fs';
import { build_markdown_from_json_schema } from '@doc-utils/jsonschema2markdown';
import { stringify as to_yaml } from 'yaml';
import { build_partials, copy_metadata, file_hash_matches, map_input_file_to_output_file, map_output_file_to_url, render_page, skip_file, update_metadata } from './helpers';
export async function render_json_schema_files(state: BuildState) {
const promises: Promise<any>[] = [ ];
const json_files = await glob(state.conf.input['schema+json'], {
absolute: true,
cwd: state.conf.input.root,
});
const yaml_files = await glob(state.conf.input['schema+yaml'], {
absolute: true,
cwd: state.conf.input.root,
});
if (! state.partials) {
await build_partials(state);
}
for (const in_file of json_files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
handle_json_schema_json_file(state, in_file)
);
}
for (const in_file of yaml_files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
handle_json_schema_yaml_file(state, in_file)
);
}
await Promise.all(promises);
}
export async function handle_json_schema_json_file(state: BuildState, in_file: string) {
const promises: Promise<any>[] = [ ];
const out_file = map_input_file_to_output_file(state, in_file, [ '.json' ], '.html');
const { frontmatter, parsed, json, hash } = await read_json(in_file, true);
promises.push(
render_json_schema(state, parsed, in_file, await out_file, hash, frontmatter)
);
if (state.conf.output.include_inputs?.includes('schema+json')) {
const json_file = await map_input_file_to_output_file(state, in_file);
promises.push(
write_text(json_file, json)
);
if (state.conf.output.include_yaml_and_json) {
const yaml_file = await map_input_file_to_output_file(state, in_file, [ '.json' ], '.yaml');
promises.push(
write_text(yaml_file, to_yaml(parsed))
);
}
}
await Promise.all(promises);
}
export async function handle_json_schema_yaml_file(state: BuildState, in_file: string) {
const promises: Promise<any>[] = [ ];
const out_file = map_input_file_to_output_file(state, in_file, [ '.yaml', '.yml' ], '.html');
const { frontmatter, parsed, yaml, hash } = await read_yaml(in_file, true);
promises.push(
render_json_schema(state, parsed, in_file, await out_file, hash, frontmatter)
);
if (state.conf.output.include_inputs?.includes('schema+yaml')) {
const yaml_file = await map_input_file_to_output_file(state, in_file);
promises.push(
write_text(yaml_file, yaml)
);
if (state.conf.output.include_yaml_and_json) {
const json_file = await map_input_file_to_output_file(state, in_file, [ '.yaml', '.yml' ], '.json');
promises.push(
write_text(json_file, JSON.stringify(parsed, null, ' '))
);
}
}
await Promise.all(promises);
}
export async function render_json_schema(state: BuildState, schema: unknown, in_file: string, out_file: string, hash: string, frontmatter?: any) {
if (frontmatter?.skip) {
return;
}
const out_url = map_output_file_to_url(state, out_file);
const promises: Promise<any>[] = [ ];
const markdown = build_markdown_from_json_schema(schema);
if (state.conf.output.include_intermediate_markdown) {
promises.push(
map_input_file_to_output_file(state, out_file, [ '.html' ], '.md')
.then((md_file) => write_text(md_file, markdown))
);
}
promises.push(
render_page(state, in_file, out_file, out_url, markdown, true, frontmatter)
);
await Promise.all(promises);
if (file_hash_matches(state, in_file, hash)) {
return copy_metadata(state, in_file);
}
update_metadata(state, in_file, hash);
}

View File

@@ -0,0 +1,49 @@
import { glob } from 'glob';
import { read_text } from '../fs';
import { BuildState } from './state';
import { build_partials, copy_metadata, file_hash_matches, map_input_file_to_output_file, map_output_file_to_url, render_page, skip_file, update_metadata } from './helpers';
export async function render_markdown_files(state: BuildState) {
const promises: Promise<any>[] = [ ];
const files = await glob(state.conf.input.markdown, {
absolute: true,
cwd: state.conf.input.root,
});
if (! state.partials) {
await build_partials(state);
}
for (const in_file of files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
render_markdown_file(state, in_file)
);
}
await Promise.all(promises);
}
export async function render_markdown_file(state: BuildState, in_file: string) {
const out_file = await map_input_file_to_output_file(state, in_file, [ '.md', '.markdown' ], '.html');
const out_url = map_output_file_to_url(state, out_file);
const { frontmatter, text, hash } = await read_text(in_file);
if (frontmatter?.skip) {
return;
}
await render_page(state, in_file, out_file, out_url, text, true, frontmatter);
if (file_hash_matches(state, in_file, hash)) {
return copy_metadata(state, in_file);
}
update_metadata(state, in_file, hash);
}

View File

@@ -0,0 +1,49 @@
import { glob } from 'glob';
import { read_text } from '../fs';
import { BuildState } from './state';
import { build_partials, copy_metadata, file_hash_matches, map_input_file_to_output_file, map_output_file_to_url, render_page, skip_file, update_metadata } from './helpers';
export async function render_text_file_templates(state: BuildState) {
const promises: Promise<any>[] = [ ];
const files = await glob(state.conf.input.text, {
absolute: true,
cwd: state.conf.input.root,
});
if (! state.partials) {
await build_partials(state);
}
for (const in_file of files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
render_text_file_template(state, in_file)
);
}
await Promise.all(promises);
}
export async function render_text_file_template(state: BuildState, in_file: string) {
const out_file = await map_input_file_to_output_file(state, in_file);
const out_url = map_output_file_to_url(state, out_file);
const { frontmatter, text, hash } = await read_text(in_file);
if (frontmatter?.skip) {
return;
}
await render_page(state, in_file, out_file, out_url, text, false, frontmatter);
if (file_hash_matches(state, in_file, hash)) {
return copy_metadata(state, in_file);
}
update_metadata(state, in_file, hash);
}

32
src/build-files/raw.ts Normal file
View File

@@ -0,0 +1,32 @@
import { glob } from 'glob';
import { BuildState } from './state';
import { promises as fs } from 'fs';
import { map_input_file_to_output_file } from './helpers';
export async function copy_raw_files(state: BuildState) {
const promises: Promise<any>[] = [ ];
const files = await glob(state.conf.input.raw, {
absolute: true,
cwd: state.conf.input.root,
});
for (const in_file of files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
const out_file = map_input_file_to_output_file(state, in_file);
// todo: check hashes to see if we can skip
promises.push(
fs.copyFile(in_file, await out_file)
);
}
await Promise.all(promises);
// todo: update metadata
}

131
src/build-files/rss.ts Normal file
View File

@@ -0,0 +1,131 @@
import type { XMLBuilder } from 'xmlbuilder2/lib/interfaces';
import { create as create_xml } from 'xmlbuilder2';
import { BuildState } from './state';
import { write_text } from '../fs';
import { app_version } from '../conf';
import { map_output_file_to_url } from './helpers';
import { DateTime } from 'luxon';
export interface RSSEntry {
url: string;
in_file: string;
title?: string;
description?: string;
author_name?: string;
html_content?: string;
tags?: string[];
}
export async function write_rss_if_needed(state: BuildState) {
if (! state.conf.rss) {
return;
}
for (let index = 0; index < state.conf.rss.length; index++) {
const rss_conf = state.conf.rss[index];
const doc = create_xml({ version: '1.0', encoding: 'UTF-8' });
const { abs_url: self_url } = map_output_file_to_url(state, rss_conf.out_file);
if (rss_conf.xsl) {
for (const url of rss_conf.xsl) {
doc.ins('xml-stylesheet', `href="${url}" type="text/xsl"`);
}
}
const rss = doc.ele('rss', {
version: '2.0',
'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
'xmlns:content': 'http://purl.org/rss/1.0/modules/content/',
'xmlns:atom': 'http://www.w3.org/2005/Atom',
// 'xmlns:docs2website': 'urn:uuid:7fc4e5d4-f68e-11ed-b0d0-00155ddef564',
});
const channel = rss.ele('channel');
channel.ele('generator').txt(`docs2website ${app_version}`);
if (rss_conf.title) {
channel.ele('title').txt(rss_conf.title);
}
if (rss_conf.link) {
channel.ele('link').txt(rss_conf.link);
}
link(channel, 'application/rss+xml', 'self', self_url);
if (rss_conf.alternates?.length) {
for (const alt of rss_conf.alternates) {
link(channel, alt.type, 'alternate', alt.href);
}
}
if (rss_conf.description) {
channel.ele('description').txt(rss_conf.description);
}
if (rss_conf.language) {
channel.ele('language').txt(rss_conf.language);
}
if (rss_conf.copyright) {
channel.ele('copyright').txt(rss_conf.copyright);
}
channel.ele('lastBuildDate').txt(state.build_time.rfc2822);
// channel.ele('rating').txt(''); // see: https://www.w3.org/PICS/
// channel.ele('pubDate').txt(publish_date.toUTCString());
// channel.ele('categories').txt('');
// channel.ele('docs').txt('');
// channel.ele('managingEditor').txt('james@jbrumond.me');
// channel.ele('webMaster').txt('james@jbrumond.me');
// channel.ele('ttl').txt('');
// channel.ele('image').txt('');
// channel.ele('skipHours').txt('');
// channel.ele('skipDays').txt('');
for (const entry of state.rss[index] || [ ]) {
const item = channel.ele('item');
const in_file = entry.in_file.slice(state.conf.input.root.length);
const metadata = state.new_metadata.files[in_file];
item.ele('link').txt(entry.url);
if (entry.title) {
item.ele('title').txt(entry.title);
}
if (entry.description) {
item.ele('description').txt(entry.description);
}
if (entry.author_name) {
item.ele('dc:creator').ele({ $: entry.author_name });
}
if (entry.tags) {
entry.tags.forEach((tag) => item.ele('category').txt(tag));
}
item.ele('guid').txt(entry.url);
item.ele('pubDate').txt(DateTime.fromISO(metadata.first_seen_time).toRFC2822());
if (entry.html_content) {
item.ele('content:encoded').ele({ $: entry.html_content });
}
}
const xml = doc.toString({
indent: ' ',
prettyPrint: true,
});
await write_text(rss_conf.out_file, xml);
}
}
function link(channel: XMLBuilder, type: string, rel: string, href: string) {
// channel.ele('link', { href, rel, type, });
channel.ele('atom:link', { type, rel, href, });
}

View File

@@ -0,0 +1,57 @@
import type { XMLBuilder } from 'xmlbuilder2/lib/interfaces';
import { create as create_xml } from 'xmlbuilder2';
import { BuildState } from './state';
import { write_text } from '../fs';
import { resolve as path_resolve } from 'path';
export async function write_sitemap_if_needed(state: BuildState) {
if (! state.conf.sitemap) {
return;
}
const doc = create_xml({ version: '1.0', encoding: 'UTF-8' });
const urlset = doc.ele('urlset', {
'xmlns': 'http://www.sitemaps.org/schemas/sitemap/0.9',
'xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
'xsi:schemaLocation': 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd'
});
for (const entry of state.sitemap) {
url_elem(urlset, entry.url, entry.lastmod, entry.change_freq, entry.priority);
}
const out_file = state.conf.sitemap.out_file || path_resolve(state.conf.output.root, 'sitemap.xml');
const xml = doc.toString({
indent: ' ',
prettyPrint: true,
});
await write_text(out_file, xml);
}
export interface SitemapEntry {
url: string;
lastmod: string;
change_freq?: ChangeFreq;
priority?: number;
}
export type ChangeFreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
function url_elem(urlset: XMLBuilder, loc: string, lastmod: string, change_freq?: ChangeFreq, priority?: number) {
const url = urlset.ele('url');
url.ele('loc').txt(loc);
url.ele('lastmod').txt(lastmod);
if (change_freq) {
url.ele('changefreq').txt(change_freq);
}
if (priority != null) {
url.ele('priority').txt(priority.toFixed(1));
}
return url;
}

42
src/build-files/state.ts Normal file
View File

@@ -0,0 +1,42 @@
import type { Config } from '../conf';
import type { Metadata } from '../metadata';
import type { ColorTheme } from '@doc-utils/color-themes';
import type { SitemapEntry } from './sitemap';
import { RSSEntry } from './rss';
import { EventEntry } from './icalendar';
export interface BuildState {
conf: Config;
seen_files: Set<string>;
env: Record<string, string>;
partials?: Record<string, string>;
layouts: Record<string, string>;
themes: Record<string, ColorTheme>;
theme_groups: ThemeGroups;
extras: Record<string, string>;
made_directories: Set<string>;
old_metadata: Metadata;
new_metadata: Metadata;
rss: RSSEntry[][];
sitemap: SitemapEntry[];
events: EventEntry[];
calendars: EventEntry[][];
build_time: {
iso: string;
rfc2822: string;
};
}
export interface ThemeGroups {
all: ColorTheme[];
light: ColorTheme[];
dark: ColorTheme[];
high_contrast: ColorTheme[];
low_contrast: ColorTheme[];
monochrome: ColorTheme[];
greyscale: ColorTheme[];
protanopia_safe: ColorTheme[];
deuteranopia_safe: ColorTheme[];
tritanopia_safe: ColorTheme[];
}

View File

@@ -1,425 +0,0 @@
import { ColorTheme } from '@doc-utils/color-themes';
import { build_markdown_from_json_schema } from '@doc-utils/jsonschema2markdown';
import { render_markdown_to_html, render_markdown_to_html_inline_sync } from '@doc-utils/markdown2html';
import { glob } from 'glob';
import { DateTime } from 'luxon';
import { stringify as to_yaml } from 'yaml';
import { promises as fs } from 'fs';
import { dirname, join as path_join } from 'path';
import { icons } from './icons';
import { Config } from './conf';
import { build_env_scope } from './env';
import { load_themes, render_theme_css_properties } from './themes';
import { mkdirp, read_json, read_text, read_yaml, write_text } from './fs';
import { load_layout, Context, render_template, load_partials, load_extras, FrontMatter } from './template';
interface BuildState {
conf: Config;
seen_files: Set<string>;
env: Record<string, string>;
partials?: Record<string, string>;
layouts: Record<string, string>;
themes: Record<string, ColorTheme>;
theme_groups: ThemeGroups;
extras: Record<string, string>;
made_directories: Set<string>;
build_time: {
iso: string;
rfc2822: string;
};
}
export interface ThemeGroups {
all: ColorTheme[];
light: ColorTheme[];
dark: ColorTheme[];
high_contrast: ColorTheme[];
low_contrast: ColorTheme[];
monochrome: ColorTheme[];
greyscale: ColorTheme[];
protanopia_safe: ColorTheme[];
deuteranopia_safe: ColorTheme[];
tritanopia_safe: ColorTheme[];
}
export async function build_docs_project(conf: Config) {
const now = DateTime.now();
const themes = await load_themes(conf);
const state: BuildState = {
conf,
seen_files: new Set<string>(),
env: build_env_scope(conf),
layouts: Object.create(null),
themes: themes,
theme_groups: {
// fixme: this is horribly inefficient
all: Object.values(themes),
light: Object.values(themes).filter((theme) => theme.labels.includes('light')),
dark: Object.values(themes).filter((theme) => theme.labels.includes('dark')),
high_contrast: Object.values(themes).filter((theme) => theme.labels.includes('high_contrast')),
low_contrast: Object.values(themes).filter((theme) => theme.labels.includes('low_contrast')),
monochrome: Object.values(themes).filter((theme) => theme.labels.includes('monochrome')),
greyscale: Object.values(themes).filter((theme) => theme.labels.includes('greyscale')),
protanopia_safe: Object.values(themes).filter((theme) => theme.labels.includes('protanopia_safe')),
deuteranopia_safe: Object.values(themes).filter((theme) => theme.labels.includes('deuteranopia_safe')),
tritanopia_safe: Object.values(themes).filter((theme) => theme.labels.includes('tritanopia_safe')),
},
extras: await load_extras(),
made_directories: new Set<string>(),
build_time: {
iso: now.toISO(),
rfc2822: now.toRFC2822(),
},
}
if (conf.input.raw) {
await copy_raw_files(state);
}
if (conf.input.text) {
await render_text_file_templates(state);
}
if (conf.input.markdown) {
await render_markdown_files(state);
}
if (conf.input['schema+json'] || conf.input['schema+yaml']) {
await render_json_schema_files(state);
}
// todo...
}
// ===== Raw File Copy =====
async function copy_raw_files(state: BuildState) {
const promises: Promise<any>[] = [ ];
const files = await glob(state.conf.input.raw, {
absolute: true,
cwd: state.conf.input.root,
});
for (const in_file of files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
const out_file = map_input_file_to_output_file(state, in_file);
promises.push(
fs.copyFile(in_file, await out_file)
);
}
await Promise.all(promises);
}
// ===== File Renderers =====
async function render_text_file_templates(state: BuildState) {
const promises: Promise<any>[] = [ ];
const files = await glob(state.conf.input.text, {
absolute: true,
cwd: state.conf.input.root,
});
if (! state.partials) {
await build_partials(state);
}
for (const in_file of files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
render_text_file_template(state, in_file)
);
}
await Promise.all(promises);
}
async function render_text_file_template(state: BuildState, in_file: string) {
const out_file = map_input_file_to_output_file(state, in_file);
const { frontmatter, text } = await read_text(in_file);
let layout: string;
const layout_file = frontmatter?.layout;
if (layout_file) {
if (! state.layouts[layout_file]) {
state.layouts[layout_file] = await load_layout(state.conf, layout_file);
}
layout = state.layouts[layout_file];
}
const tags = state.conf.templates?.tags;
const context = mustache_context(state, frontmatter);
const rendered = render_template(text, context, layout, structuredClone(state.partials), tags);
await write_text(await out_file, rendered);
}
async function render_markdown_files(state: BuildState) {
const promises: Promise<any>[] = [ ];
const files = await glob(state.conf.input.markdown, {
absolute: true,
cwd: state.conf.input.root,
});
if (! state.partials) {
await build_partials(state);
}
for (const in_file of files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
render_markdown_file(state, in_file)
);
}
await Promise.all(promises);
}
async function render_markdown_file(state: BuildState, in_file: string) {
const out_file = map_input_file_to_output_file(state, in_file, [ '.md', '.markdown' ], '.html');
const { frontmatter, text } = await read_text(in_file);
const html = render_markdown_to_html(text, state.conf.markdown);
let layout: string;
const layout_file = frontmatter?.layout;
if (layout_file) {
if (! state.layouts[layout_file]) {
state.layouts[layout_file] = await load_layout(state.conf, layout_file);
}
layout = state.layouts[layout_file];
}
const tags = state.conf.templates?.tags;
const context = mustache_context(state, frontmatter);
const rendered = render_template(await html, context, layout, structuredClone(state.partials), tags);
await write_text(await out_file, rendered);
}
async function render_json_schema_files(state: BuildState) {
const promises: Promise<any>[] = [ ];
const json_files = await glob(state.conf.input['schema+json'], {
absolute: true,
cwd: state.conf.input.root,
});
const yaml_files = await glob(state.conf.input['schema+yaml'], {
absolute: true,
cwd: state.conf.input.root,
});
if (! state.partials) {
await build_partials(state);
}
for (const in_file of json_files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
handle_json_schema_json_file(state, in_file)
);
}
for (const in_file of yaml_files) {
if (state.seen_files.has(in_file)) {
continue;
}
state.seen_files.add(in_file);
promises.push(
handle_json_schema_yaml_file(state, in_file)
);
}
await Promise.all(promises);
}
async function handle_json_schema_json_file(state: BuildState, in_file: string) {
const promises: Promise<any>[] = [ ];
const out_file = map_input_file_to_output_file(state, in_file, [ '.json' ], '.html');
const { frontmatter, parsed, json } = await read_json(in_file, true);
promises.push(
render_json_schema(state, parsed, await out_file, frontmatter)
);
if (state.conf.output.include_inputs?.includes('schema+json')) {
const json_file = await map_input_file_to_output_file(state, in_file);
promises.push(
write_text(json_file, json)
);
if (state.conf.output.include_yaml_and_json) {
const yaml_file = await map_input_file_to_output_file(state, in_file, [ '.json' ], '.yaml');
promises.push(
write_text(yaml_file, to_yaml(parsed))
);
}
}
await Promise.all(promises);
}
async function handle_json_schema_yaml_file(state: BuildState, in_file: string) {
const promises: Promise<any>[] = [ ];
const out_file = map_input_file_to_output_file(state, in_file, [ '.yaml', '.yml' ], '.html');
const { frontmatter, parsed, yaml } = await read_yaml(in_file, true);
promises.push(
render_json_schema(state, parsed, await out_file, frontmatter)
);
if (state.conf.output.include_inputs?.includes('schema+yaml')) {
const yaml_file = await map_input_file_to_output_file(state, in_file);
promises.push(
write_text(yaml_file, yaml)
);
if (state.conf.output.include_yaml_and_json) {
const json_file = await map_input_file_to_output_file(state, in_file, [ '.yaml', '.yml' ], '.json');
promises.push(
write_text(json_file, JSON.stringify(parsed, null, ' '))
);
}
}
await Promise.all(promises);
}
async function render_json_schema(state: BuildState, schema: unknown, out_file: string, frontmatter?: any) {
const promises: Promise<any>[] = [ ];
const markdown = build_markdown_from_json_schema(schema);
if (state.conf.output.include_intermediate_markdown) {
promises.push(
map_input_file_to_output_file(state, out_file, [ '.html' ], '.md')
.then((md_file) => write_text(md_file, markdown))
);
}
const html = render_markdown_to_html(markdown, state.conf.markdown);
let layout: string;
const layout_file = frontmatter?.layout;
if (layout_file) {
if (! state.layouts[layout_file]) {
state.layouts[layout_file] = await load_layout(state.conf, layout_file);
}
layout = state.layouts[layout_file];
}
const tags = state.conf.templates?.tags;
const context = mustache_context(state, frontmatter);
const rendered = render_template(await html, context, layout, structuredClone(state.partials), tags);
promises.push(
write_text(await out_file, rendered)
);
await Promise.all(promises);
}
// ===== Helpers =====
async function map_input_file_to_output_file(state: BuildState, in_file: string, remove_exts?: string[], add_ext?: string) {
if (! in_file.startsWith(state.conf.input.root)) {
throw new Error('input file expected to be inside input root');
}
let out_file = path_join(state.conf.output.root, in_file.slice(state.conf.input.root.length));
if (remove_exts) {
for (const ext of remove_exts) {
if (out_file.endsWith(ext)) {
out_file = out_file.slice(0, -ext.length);
break;
}
}
}
if (add_ext) {
out_file += add_ext;
}
const dir = dirname(out_file);
if (! state.made_directories.has(dir)) {
state.made_directories.add(dir);
await mkdirp(dir);
}
return out_file;
}
async function build_partials(state: BuildState) {
state.partials = await load_partials(state.conf);
for (const [name, theme] of Object.entries(state.themes)) {
state.partials[`.themes/${name}`] = render_theme_css_properties(theme);
}
Object.assign(state.partials, state.extras);
}
function mustache_context(state: BuildState, frontmatter?: FrontMatter) : Context {
return {
env: state.env,
page: frontmatter,
build_time: state.build_time,
icons: icons,
themes: Object.values(state.themes),
theme_groups: structuredClone(state.theme_groups),
markdown: {
render_inline() {
return (text, render) => {
const md = render(text)
const html = render_markdown_to_html_inline_sync(md, state.conf.markdown);
return html;
};
},
}
};
}

View File

@@ -4,17 +4,59 @@ import { parse as parse_yaml } from 'yaml';
import { resolve as resolve_path, dirname } from 'path'; import { resolve as resolve_path, dirname } from 'path';
import { MarkdownOptions } from '@doc-utils/markdown2html'; import { MarkdownOptions } from '@doc-utils/markdown2html';
export const app_version = require('../package.json').version;
export async function read_config(file: string) { export async function read_config(file: string) {
const path = resolve_path(process.cwd(), file); const path = resolve_path(process.cwd(), file);
const yaml = await fs.readFile(path, 'utf8'); const yaml = await fs.readFile(path, 'utf8');
const config = parse_yaml(yaml); const config = parse_yaml(yaml);
validate_config(config); validate_config(config);
config.title = resolve_env_var_if_needed(config.title);
config.metadata = resolve_env_var_if_needed(config.metadata);
config.base_url = resolve_env_var_if_needed(config.base_url);
config.input.root = resolve_env_var_if_needed(config.input.root);
config.output.root = resolve_env_var_if_needed(config.output.root);
process_markdown_config(config); process_markdown_config(config);
resolve_paths(path, config); resolve_paths(path, config);
return config; return config;
} }
export interface RSSConfig {
in_dir: string;
out_file: string;
title?: string;
description?: string;
link?: string;
xsl?: string[];
language?: string;
copyright?: string;
alternates?: {
type: string;
href: string;
}[];
}
export interface CalendarConfig {
in_dir?: string;
out_file?: string;
title?: string;
}
export interface AuthorConfig {
name?: string;
email?: string;
url?: string;
}
export interface Config { export interface Config {
title: string;
metadata: string;
base_url: string;
authors?: Record<string, AuthorConfig>;
input: { input: {
root: string; root: string;
raw?: string[]; raw?: string[];
@@ -39,13 +81,20 @@ export interface Config {
include_yaml_and_json?: boolean; include_yaml_and_json?: boolean;
include_intermediate_markdown?: boolean; include_intermediate_markdown?: boolean;
}; };
markdown?: MarkdownOptions; sitemap?: false | {
out_file?: string;
};
rss?: false | RSSConfig[];
events?: false | {
};
calendars?: false | CalendarConfig[];
markdown?: Omit<MarkdownOptions, 'base_url' | 'inline' | 'extensions'>;
schema?: { schema?: {
// //
}; };
openapi?: { openapi?: {
// ; // ;
} };
// ... // ...
} }
@@ -57,6 +106,7 @@ function resolve_paths(file_path: string, config: Config) {
const base_path = dirname(file_path); const base_path = dirname(file_path);
config.input.root = resolve_path(base_path, config.input.root); config.input.root = resolve_path(base_path, config.input.root);
config.output.root = resolve_path(base_path, config.output.root); config.output.root = resolve_path(base_path, config.output.root);
config.metadata = resolve_path(base_path, config.metadata);
if (config.templates?.layouts) { if (config.templates?.layouts) {
config.templates.layouts = resolve_path(base_path, config.templates.layouts); config.templates.layouts = resolve_path(base_path, config.templates.layouts);
@@ -65,6 +115,36 @@ function resolve_paths(file_path: string, config: Config) {
if (config.templates?.partials) { if (config.templates?.partials) {
config.templates.partials = resolve_path(base_path, config.templates.partials); config.templates.partials = resolve_path(base_path, config.templates.partials);
} }
if ((config.sitemap as boolean) === true) {
config.sitemap = { };
}
if ((config.events as boolean) === true) {
config.events = { };
}
if (Array.isArray(config.rss)) {
for (const rss_conf of config.rss) {
if (rss_conf.in_dir) {
rss_conf.in_dir = resolve_path(config.input.root, rss_conf.in_dir);
rss_conf.out_file = resolve_path(config.output.root, rss_conf.out_file);
}
}
}
if (config.sitemap && typeof config.sitemap === 'object' && config.sitemap.out_file) {
config.sitemap.out_file = resolve_path(config.output.root, config.sitemap.out_file);
}
if (Array.isArray(config.calendars)) {
for (const cal_conf of config.calendars) {
if (cal_conf.in_dir) {
cal_conf.in_dir = resolve_path(config.input.root, cal_conf.in_dir);
cal_conf.out_file = resolve_path(config.output.root, cal_conf.out_file);
}
}
}
} }
function process_markdown_config(config: any) { function process_markdown_config(config: any) {
@@ -82,3 +162,11 @@ function process_markdown_config(config: any) {
} }
} }
} }
function resolve_env_var_if_needed<T>(value: T | { from_env: string }) : T | string {
if (typeof value === 'object' && 'from_env' in value) {
return process.env[value.from_env];
}
return value;
}

View File

@@ -3,6 +3,7 @@ import { process_frontmatter } from '@doc-utils/markdown2html';
import { promises as fs } from 'fs'; import { promises as fs } from 'fs';
import { resolve as resolve_path } from 'path'; import { resolve as resolve_path } from 'path';
import { parse as parse_yaml, stringify as to_yaml } from 'yaml'; import { parse as parse_yaml, stringify as to_yaml } from 'yaml';
import { hash_str } from './hash';
export async function load_from_dir(dir: string, file: string) { export async function load_from_dir(dir: string, file: string) {
if (! dir) { if (! dir) {
@@ -18,41 +19,58 @@ export function mkdirp(dir: string, mode = 0o700) {
return fs.mkdir(dir, { mode, recursive: true }); return fs.mkdir(dir, { mode, recursive: true });
} }
export async function read_text(file: string, check_for_frontmatter = true) { export async function with_default_if_missing<T>(read_promise: Promise<T>, default_value: T) : Promise<T> {
try {
return await read_promise;
}
catch (error) {
if (error?.code === 'ENOENT') {
return default_value;
}
throw error;
}
}
export async function read_text(file: string, check_for_frontmatter = true, compute_hash = true) {
const text = await fs.readFile(file, 'utf8'); const text = await fs.readFile(file, 'utf8');
const hash = compute_hash ? hash_str(text) : null;
if (check_for_frontmatter) { if (check_for_frontmatter) {
const { frontmatter, document } = process_frontmatter(text); const { frontmatter, document } = process_frontmatter(text);
return { frontmatter, text: document }; return { frontmatter, text: document, hash };
} }
return { text, frontmatter: null }; return { text, frontmatter: null, hash };
} }
export async function read_json(file: string, check_for_frontmatter = true) { export async function read_json(file: string, check_for_frontmatter = true, compute_hash = true) {
const json = await fs.readFile(file, 'utf8'); const json = await fs.readFile(file, 'utf8');
const hash = compute_hash ? hash_str(json) : null;
if (check_for_frontmatter) { if (check_for_frontmatter) {
const { frontmatter, document } = process_frontmatter(json); const { frontmatter, document } = process_frontmatter(json);
const parsed = JSON.parse(document); const parsed = JSON.parse(document);
return { frontmatter, json: document, parsed }; return { frontmatter, json: document, parsed, hash };
} }
const parsed = JSON.parse(json); const parsed = JSON.parse(json);
return { json, parsed, frontmatter: null }; return { json, parsed, frontmatter: null, hash };
} }
export async function read_yaml(file: string, check_for_frontmatter = true) { export async function read_yaml(file: string, check_for_frontmatter = true, compute_hash = true) {
const yaml = await fs.readFile(file, 'utf8'); const yaml = await fs.readFile(file, 'utf8');
const hash = compute_hash ? hash_str(yaml) : null;
if (check_for_frontmatter) { if (check_for_frontmatter) {
const { frontmatter, document } = process_frontmatter(yaml); const { frontmatter, document } = process_frontmatter(yaml);
const parsed = parse_yaml(document); const parsed = parse_yaml(document);
return { frontmatter, yaml: document, parsed }; return { frontmatter, yaml: document, parsed, hash };
} }
const parsed = parse_yaml(yaml); const parsed = parse_yaml(yaml);
return { yaml, parsed, frontmatter: null }; return { yaml, parsed, frontmatter: null, hash };
} }
export function write_text(file: string, text: string) { export function write_text(file: string, text: string) {

14
src/hash.ts Normal file
View File

@@ -0,0 +1,14 @@
import { createHash } from 'crypto';
export function hash_str(str: string) {
const hash = createHash('sha512');
hash.update(str);
return hash.digest('base64');
}
export function hash_obj(obj: any) {
// todo: use something more stable
const str = JSON.stringify(obj);
return hash_str(str);
}

View File

@@ -1,3 +1,3 @@
export { read_config, Config } from './conf'; export { read_config, Config } from './conf';
export { build_docs_project, ThemeGroups } from './build'; export { build_docs_project, ThemeGroups } from './build-files';

20
src/metadata.ts Normal file
View File

@@ -0,0 +1,20 @@
export interface Metadata {
last_build: BuildMetadata;
files: {
[file_path: string]: FileMetadata;
};
}
export interface BuildMetadata {
time: string;
config_hash: string;
}
export interface FileMetadata {
first_seen_time: string;
last_build_hash: string;
last_updated_time: string;
}
//

View File

@@ -1,19 +1,26 @@
import { Config } from './conf'; import { AuthorConfig, CalendarConfig, Config, RSSConfig } from './conf';
import { render as mustache_render } from 'mustache'; import { render as mustache_render } from 'mustache';
import { promises as fs } from 'fs'; import { promises as fs } from 'fs';
import { resolve as resolve_path } from 'path'; import { resolve as resolve_path } from 'path';
import { glob } from 'glob'; import { glob } from 'glob';
import { load_from_dir } from './fs'; import { load_from_dir } from './fs';
import { ColorTheme } from '@doc-utils/color-themes'; import { ColorTheme } from '@doc-utils/color-themes';
import { ThemeGroups } from './build'; import { ThemeGroups } from './build-files';
import { ChangeFreq } from './build-files/sitemap';
export interface Context { export interface Context {
env?: Record<string, string>; env?: Record<string, string>;
page?: FrontMatter; page?: FrontMatter;
base_url: string;
page_url: string;
site_title: string;
author: AuthorConfig | AuthorConfig[];
icons: Record<string, string>; icons: Record<string, string>;
themes: ColorTheme[]; themes: ColorTheme[];
theme_groups: ThemeGroups; theme_groups: ThemeGroups;
rss_feeds: RSSConfig[];
calendars: CalendarConfig[];
build_time: { build_time: {
iso: string; iso: string;
rfc2822: string; rfc2822: string;
@@ -24,11 +31,33 @@ export interface Context {
} }
export interface FrontMatter { export interface FrontMatter {
title?: string; skip?: boolean;
layout?: string; layout?: string;
title?: string;
description?: string;
tags?: string[];
author?: string | string[];
rss?: RSSFrontmatter;
sitemap?: SitemapFrontmatter;
event?: EventFrontmatter;
[key: string]: unknown; [key: string]: unknown;
} }
interface SitemapFrontmatter {
change_freq?: ChangeFreq;
priority?: number;
}
interface EventFrontmatter {
start_time?: string;
end_time?: string;
time_zone?: `${string}/${string}`;
}
interface RSSFrontmatter {
//
}
export function render_template(template: string, context: Context, layout?: string, partials: Record<string, string> = { }, tags?: [ string, string ]) { export function render_template(template: string, context: Context, layout?: string, partials: Record<string, string> = { }, tags?: [ string, string ]) {
partials['.content'] = template; partials['.content'] = template;
return mustache_render(layout || template, context, partials, tags); return mustache_render(layout || template, context, partials, tags);
@@ -42,6 +71,13 @@ export async function load_extras() {
'components/outline-button.js', 'components/outline-button.js',
'components/outline-inline.js', 'components/outline-inline.js',
'prism.css', 'prism.css',
'typography/spacious.css',
'typography/compact.css',
'typography/general.css',
'theme-animation.css',
'forms-inputs/spacious.css',
'forms-inputs/compact.css',
'forms-inputs/general.css',
]; ];
const promises = extras_files.map((file) => load_from_dir(extras_dir, file)); const promises = extras_files.map((file) => load_from_dir(extras_dir, file));

54
src/time.ts Normal file
View File

@@ -0,0 +1,54 @@
import { DateTime } from 'luxon';
export function now(zone?: string) {
return zone
? DateTime.now().setZone(zone)
: DateTime.now();
}
export function from_iso(time: string, zone?: string) {
return zone
? DateTime.fromISO(time, { zone })
: DateTime.fromISO(time);
}
// function date_formatters(lang: string, time_zone: string) {
// return {
// date() {
// return (text, render) => {
// return format_with_config(render(text), {
// dateStyle: 'short',
// timeZone: time_zone,
// });
// };
// },
// time() {
// return (text, render) => {
// return format_with_config(render(text), {
// timeStyle: 'long',
// timeZone: time_zone,
// });
// };
// },
// datetime() {
// return (text, render) => {
// return format_with_config(render(text), {
// dateStyle: 'short',
// timeStyle: 'long',
// timeZone: time_zone,
// });
// };
// },
// };
// function format_with_config(text: string, config: Intl.DateTimeFormatOptions) {
// const date = new Date(text.trim());
// const formatter = new Intl.DateTimeFormat(lang, config);
// return formatter.format(date);
// }
// }