From 214ce4934d3e2ba9b7574690481378ea17a281d3 Mon Sep 17 00:00:00 2001 From: Ax333l Date: Tue, 25 Oct 2022 10:17:29 +0200 Subject: [PATCH 1/3] feat: generate doc pages from markup --- .gitignore | 2 + package-lock.json | 460 ++++++++++++++++-- package.json | 8 +- src/lib/components/atoms/DocsNavNode.svelte | 29 ++ .../components/molecules/DocsNavTree.svelte | 39 ++ src/lib/components/molecules/NavHost.svelte | 10 +- src/lib/documentation.scss | 45 ++ src/lib/documentation.server.ts | 202 ++++++++ src/lib/documentation.shared.ts | 28 ++ src/routes/docs/+layout.server.ts | 10 + src/routes/docs/+layout.svelte | 34 ++ src/routes/docs/+page.svelte | 126 ----- src/routes/docs/[...slug]/+page.server.ts | 17 + src/routes/docs/[...slug]/+page.svelte | 22 + testing-docs/adoc-format.adoc | 10 + testing-docs/deeply/another-page.md | 4 + testing-docs/deeply/index.md | 4 + testing-docs/deeply/nested/content/index.md | 4 + testing-docs/deeply/nested/index.md | 4 + testing-docs/index.md | 16 + testing-docs/markdown-format.md | 4 + testing-docs/writing-docs.md | 9 + 22 files changed, 911 insertions(+), 176 deletions(-) create mode 100644 src/lib/components/atoms/DocsNavNode.svelte create mode 100644 src/lib/components/molecules/DocsNavTree.svelte create mode 100644 src/lib/documentation.scss create mode 100644 src/lib/documentation.server.ts create mode 100644 src/lib/documentation.shared.ts create mode 100644 src/routes/docs/+layout.server.ts create mode 100644 src/routes/docs/+layout.svelte delete mode 100644 src/routes/docs/+page.svelte create mode 100644 src/routes/docs/[...slug]/+page.server.ts create mode 100644 src/routes/docs/[...slug]/+page.svelte create mode 100644 testing-docs/adoc-format.adoc create mode 100644 testing-docs/deeply/another-page.md create mode 100644 testing-docs/deeply/index.md create mode 100644 testing-docs/deeply/nested/content/index.md create mode 100644 testing-docs/deeply/nested/index.md create mode 100644 testing-docs/index.md create mode 100644 testing-docs/markdown-format.md create mode 100644 testing-docs/writing-docs.md diff --git a/.gitignore b/.gitignore index ac50a28..0cdcff8 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,5 @@ node_modules .env .env.* !.env.example +/_docs_src +/static/docs diff --git a/package-lock.json b/package-lock.json index 46d2c59..5c346e4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,9 +7,14 @@ "": { "name": "revanced-website", "version": "0.0.1", + "dependencies": { + "asciidoctor": "^2.2.6", + "marked": "^4.1.1" + }, "devDependencies": { "@sveltejs/adapter-static": "next", "@sveltejs/kit": "next", + "@types/marked": "^4.0.7", "@typescript-eslint/eslint-plugin": "^5.27.0", "@typescript-eslint/parser": "^5.27.0", "eslint": "^8.16.0", @@ -17,6 +22,7 @@ "eslint-plugin-svelte3": "^4.0.0", "prettier": "^2.6.2", "prettier-plugin-svelte": "^2.7.0", + "sass": "^1.55.0", "sirv-cli": "^2.0.2", "svelte": "^3.44.0", "svelte-check": "^2.7.1", @@ -26,6 +32,39 @@ "vite": "^3.0.0" } }, + "node_modules/@asciidoctor/cli": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/@asciidoctor/cli/-/cli-3.5.0.tgz", + "integrity": "sha512-/VMHXcZBnZ9vgWfmqk9Hu0x0gMjPLup0YGq/xA8qCQuk11kUIZNMVQwgSsIUzOEwJqIUD7CgncJdtfwv1Ndxuw==", + "dependencies": { + "yargs": "16.2.0" + }, + "bin": { + "asciidoctor": "bin/asciidoctor", + "asciidoctorjs": "bin/asciidoctor" + }, + "engines": { + "node": ">=8.11", + "npm": ">=5.0.0" + }, + "peerDependencies": { + "@asciidoctor/core": "^2.0.0-rc.1" + } + }, + "node_modules/@asciidoctor/core": { + "version": "2.2.6", + "resolved": "https://registry.npmjs.org/@asciidoctor/core/-/core-2.2.6.tgz", + "integrity": "sha512-TmB2K5UfpDpSbCNBBntXzKHcAk2EA3/P68jmWvmJvglVUdkO9V6kTAuXVe12+h6C4GK0ndwuCrHHtEVcL5t6pQ==", + "dependencies": { + "asciidoctor-opal-runtime": "0.3.3", + "unxhr": "1.0.1" + }, + "engines": { + "node": ">=8.11", + "npm": ">=5.0.0", + "yarn": ">=1.1.0" + } + }, "node_modules/@eslint/eslintrc": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.3.3.tgz", @@ -237,6 +276,12 @@ "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==", "dev": true }, + "node_modules/@types/marked": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/@types/marked/-/marked-4.0.7.tgz", + "integrity": "sha512-eEAhnz21CwvKVW+YvRvcTuFKNU9CV1qH+opcgVK3pIMI6YZzDm6gc8o2vHjldFk6MGKt5pueSB7IOpvpx5Qekw==", + "dev": true + }, "node_modules/@types/node": { "version": "18.11.3", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.3.tgz", @@ -491,7 +536,6 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true, "engines": { "node": ">=8" } @@ -500,7 +544,6 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, "dependencies": { "color-convert": "^2.0.1" }, @@ -539,11 +582,40 @@ "node": ">=8" } }, + "node_modules/asciidoctor": { + "version": "2.2.6", + "resolved": "https://registry.npmjs.org/asciidoctor/-/asciidoctor-2.2.6.tgz", + "integrity": "sha512-EXG3+F2pO21B+COfQmV/WgEgGiy7nG/mJiS/o5DXpaT2q82FRZWPVkbMZrpDvpu4pjXe5c754RbZR9Vz0L0Vtw==", + "dependencies": { + "@asciidoctor/cli": "3.5.0", + "@asciidoctor/core": "2.2.6" + }, + "bin": { + "asciidoctor": "bin/asciidoctor", + "asciidoctorjs": "bin/asciidoctor" + }, + "engines": { + "node": ">=8.11", + "npm": ">=5.0.0", + "yarn": ">=1.1.0" + } + }, + "node_modules/asciidoctor-opal-runtime": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/asciidoctor-opal-runtime/-/asciidoctor-opal-runtime-0.3.3.tgz", + "integrity": "sha512-/CEVNiOia8E5BMO9FLooo+Kv18K4+4JBFRJp8vUy/N5dMRAg+fRNV4HA+o6aoSC79jVU/aT5XvUpxSxSsTS8FQ==", + "dependencies": { + "glob": "7.1.3", + "unxhr": "1.0.1" + }, + "engines": { + "node": ">=8.11" + } + }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" }, "node_modules/binary-extensions": { "version": "2.2.0", @@ -558,7 +630,6 @@ "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -661,11 +732,20 @@ "node": ">= 6" } }, + "node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, "dependencies": { "color-name": "~1.1.4" }, @@ -676,14 +756,12 @@ "node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" }, "node_modules/console-clear": { "version": "1.1.1", @@ -788,6 +866,11 @@ "node": ">=6.0.0" } }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + }, "node_modules/es6-promise": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-3.3.1.tgz", @@ -847,6 +930,14 @@ "node": ">=12" } }, + "node_modules/escalade": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", + "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", + "engines": { + "node": ">=6" + } + }, "node_modules/escape-string-regexp": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", @@ -1207,8 +1298,7 @@ "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", - "dev": true + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==" }, "node_modules/function-bind": { "version": "1.1.1", @@ -1216,6 +1306,14 @@ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, "node_modules/get-port": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/get-port/-/get-port-3.2.0.tgz", @@ -1225,6 +1323,22 @@ "node": ">=4" } }, + "node_modules/glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + } + }, "node_modules/glob-parent": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", @@ -1326,6 +1440,12 @@ "node": ">= 4" } }, + "node_modules/immutable": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.1.0.tgz", + "integrity": "sha512-oNkuqVTA8jqG1Q6c+UglTOD1xhC1BtjKI7XkCXRkZHrN5m18/XsnUp8Q89GkQO/z+0WjonSvl0FLhDYftp46nQ==", + "dev": true + }, "node_modules/import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", @@ -1364,7 +1484,6 @@ "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", - "dev": true, "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -1373,8 +1492,7 @@ "node_modules/inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "dev": true + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" }, "node_modules/is-binary-path": { "version": "2.1.0", @@ -1409,6 +1527,14 @@ "node": ">=0.10.0" } }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "engines": { + "node": ">=8" + } + }, "node_modules/is-glob": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", @@ -1542,6 +1668,17 @@ "node": ">=12" } }, + "node_modules/marked": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.1.1.tgz", + "integrity": "sha512-0cNMnTcUJPxbA6uWmCmjWz4NJRe/0Xfk2NhXCUHjew9qJzFN20krFnsUe7QynwqOwa5m1fZ4UDg0ycKFVC0ccw==", + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, "node_modules/merge2": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", @@ -1589,7 +1726,6 @@ "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, "dependencies": { "brace-expansion": "^1.1.7" }, @@ -1673,7 +1809,6 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", - "dev": true, "dependencies": { "wrappy": "1" } @@ -1750,7 +1885,6 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", - "dev": true, "engines": { "node": ">=0.10.0" } @@ -1908,6 +2042,14 @@ "url": "https://github.com/sponsors/mysticatea" } }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/resolve": { "version": "1.22.1", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", @@ -2049,6 +2191,23 @@ "rimraf": "bin.js" } }, + "node_modules/sass": { + "version": "1.55.0", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.55.0.tgz", + "integrity": "sha512-Pk+PMy7OGLs9WaxZGJMn7S96dvlyVBwwtToX895WmCpAOr5YiJYEUJfiJidMuKb613z2xNWcXCHEuOvjZbqC6A==", + "dev": true, + "dependencies": { + "chokidar": ">=3.0.0 <4.0.0", + "immutable": "^4.0.0", + "source-map-js": ">=0.6.2 <2.0.0" + }, + "bin": { + "sass": "sass.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/semiver": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/semiver/-/semiver-1.1.0.tgz", @@ -2184,11 +2343,23 @@ "node": ">=10.0.0" } }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, "dependencies": { "ansi-regex": "^5.0.1" }, @@ -2484,6 +2655,14 @@ "node": ">=12.18" } }, + "node_modules/unxhr": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unxhr/-/unxhr-1.0.1.tgz", + "integrity": "sha512-MAhukhVHyaLGDjyDYhy8gVjWJyhTECCdNsLwlMoGFoNJ3o79fpQhtQuzmAE4IxCMDwraF4cW8ZjpAV0m9CRQbg==", + "engines": { + "node": ">=8.11" + } + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -2573,11 +2752,34 @@ "node": ">=0.10.0" } }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", - "dev": true + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "engines": { + "node": ">=10" + } }, "node_modules/yallist": { "version": "4.0.0", @@ -2585,6 +2787,31 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, + "node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", + "engines": { + "node": ">=10" + } + }, "node_modules/yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", @@ -2599,6 +2826,23 @@ } }, "dependencies": { + "@asciidoctor/cli": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/@asciidoctor/cli/-/cli-3.5.0.tgz", + "integrity": "sha512-/VMHXcZBnZ9vgWfmqk9Hu0x0gMjPLup0YGq/xA8qCQuk11kUIZNMVQwgSsIUzOEwJqIUD7CgncJdtfwv1Ndxuw==", + "requires": { + "yargs": "16.2.0" + } + }, + "@asciidoctor/core": { + "version": "2.2.6", + "resolved": "https://registry.npmjs.org/@asciidoctor/core/-/core-2.2.6.tgz", + "integrity": "sha512-TmB2K5UfpDpSbCNBBntXzKHcAk2EA3/P68jmWvmJvglVUdkO9V6kTAuXVe12+h6C4GK0ndwuCrHHtEVcL5t6pQ==", + "requires": { + "asciidoctor-opal-runtime": "0.3.3", + "unxhr": "1.0.1" + } + }, "@eslint/eslintrc": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.3.3.tgz", @@ -2757,6 +3001,12 @@ "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==", "dev": true }, + "@types/marked": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/@types/marked/-/marked-4.0.7.tgz", + "integrity": "sha512-eEAhnz21CwvKVW+YvRvcTuFKNU9CV1qH+opcgVK3pIMI6YZzDm6gc8o2vHjldFk6MGKt5pueSB7IOpvpx5Qekw==", + "dev": true + }, "@types/node": { "version": "18.11.3", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.3.tgz", @@ -2909,14 +3159,12 @@ "ansi-regex": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" }, "ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, "requires": { "color-convert": "^2.0.1" } @@ -2943,11 +3191,28 @@ "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", "dev": true }, + "asciidoctor": { + "version": "2.2.6", + "resolved": "https://registry.npmjs.org/asciidoctor/-/asciidoctor-2.2.6.tgz", + "integrity": "sha512-EXG3+F2pO21B+COfQmV/WgEgGiy7nG/mJiS/o5DXpaT2q82FRZWPVkbMZrpDvpu4pjXe5c754RbZR9Vz0L0Vtw==", + "requires": { + "@asciidoctor/cli": "3.5.0", + "@asciidoctor/core": "2.2.6" + } + }, + "asciidoctor-opal-runtime": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/asciidoctor-opal-runtime/-/asciidoctor-opal-runtime-0.3.3.tgz", + "integrity": "sha512-/CEVNiOia8E5BMO9FLooo+Kv18K4+4JBFRJp8vUy/N5dMRAg+fRNV4HA+o6aoSC79jVU/aT5XvUpxSxSsTS8FQ==", + "requires": { + "glob": "7.1.3", + "unxhr": "1.0.1" + } + }, "balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" }, "binary-extensions": { "version": "2.2.0", @@ -2959,7 +3224,6 @@ "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -3032,11 +3296,20 @@ } } }, + "cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "requires": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, "color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, "requires": { "color-name": "~1.1.4" } @@ -3044,14 +3317,12 @@ "color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" }, "console-clear": { "version": "1.1.1", @@ -3127,6 +3398,11 @@ "esutils": "^2.0.2" } }, + "emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + }, "es6-promise": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-3.3.1.tgz", @@ -3170,6 +3446,11 @@ "dev": true, "optional": true }, + "escalade": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", + "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==" + }, "escape-string-regexp": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", @@ -3448,8 +3729,7 @@ "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", - "dev": true + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==" }, "function-bind": { "version": "1.1.1", @@ -3457,12 +3737,30 @@ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, + "get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==" + }, "get-port": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/get-port/-/get-port-3.2.0.tgz", "integrity": "sha512-x5UJKlgeUiNT8nyo/AcnwLnZuZNcSjSw0kogRB+Whd1fjjFq4B1hySFxSFWWSn4mIBzg3sRNUDFYc4g5gjPoLg==", "dev": true }, + "glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, "glob-parent": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", @@ -3540,6 +3838,12 @@ "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", "dev": true }, + "immutable": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.1.0.tgz", + "integrity": "sha512-oNkuqVTA8jqG1Q6c+UglTOD1xhC1BtjKI7XkCXRkZHrN5m18/XsnUp8Q89GkQO/z+0WjonSvl0FLhDYftp46nQ==", + "dev": true + }, "import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", @@ -3568,7 +3872,6 @@ "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", - "dev": true, "requires": { "once": "^1.3.0", "wrappy": "1" @@ -3577,8 +3880,7 @@ "inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "dev": true + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" }, "is-binary-path": { "version": "2.1.0", @@ -3604,6 +3906,11 @@ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", "dev": true }, + "is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==" + }, "is-glob": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", @@ -3707,6 +4014,11 @@ "sourcemap-codec": "^1.4.8" } }, + "marked": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.1.1.tgz", + "integrity": "sha512-0cNMnTcUJPxbA6uWmCmjWz4NJRe/0Xfk2NhXCUHjew9qJzFN20krFnsUe7QynwqOwa5m1fZ4UDg0ycKFVC0ccw==" + }, "merge2": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", @@ -3739,7 +4051,6 @@ "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, "requires": { "brace-expansion": "^1.1.7" } @@ -3799,7 +4110,6 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", - "dev": true, "requires": { "wrappy": "1" } @@ -3854,8 +4164,7 @@ "path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", - "dev": true + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==" }, "path-key": { "version": "3.1.1", @@ -3944,6 +4253,11 @@ "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", "dev": true }, + "require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==" + }, "resolve": { "version": "1.22.1", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", @@ -4041,6 +4355,17 @@ } } }, + "sass": { + "version": "1.55.0", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.55.0.tgz", + "integrity": "sha512-Pk+PMy7OGLs9WaxZGJMn7S96dvlyVBwwtToX895WmCpAOr5YiJYEUJfiJidMuKb613z2xNWcXCHEuOvjZbqC6A==", + "dev": true, + "requires": { + "chokidar": ">=3.0.0 <4.0.0", + "immutable": "^4.0.0", + "source-map-js": ">=0.6.2 <2.0.0" + } + }, "semiver": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/semiver/-/semiver-1.1.0.tgz", @@ -4140,11 +4465,20 @@ "integrity": "sha512-Mcc5wHehp9aXz1ax6bZUyY5afg9u2rv5cqQI3mRrYkGC8rW2hM02jWuwjtL++LS5qinSyhj2QfLyNsuc+VsExg==", "dev": true }, + "string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "requires": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + } + }, "strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, "requires": { "ansi-regex": "^5.0.1" } @@ -4323,6 +4657,11 @@ "busboy": "^1.6.0" } }, + "unxhr": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unxhr/-/unxhr-1.0.1.tgz", + "integrity": "sha512-MAhukhVHyaLGDjyDYhy8gVjWJyhTECCdNsLwlMoGFoNJ3o79fpQhtQuzmAE4IxCMDwraF4cW8ZjpAV0m9CRQbg==" + }, "uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -4371,11 +4710,25 @@ "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", "dev": true }, + "wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + }, "wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", - "dev": true + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" + }, + "y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==" }, "yallist": { "version": "4.0.0", @@ -4383,6 +4736,25 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, + "yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "requires": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + } + }, + "yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==" + }, "yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", diff --git a/package.json b/package.json index da1f397..637003e 100644 --- a/package.json +++ b/package.json @@ -15,6 +15,7 @@ "devDependencies": { "@sveltejs/adapter-static": "next", "@sveltejs/kit": "next", + "@types/marked": "^4.0.7", "@typescript-eslint/eslint-plugin": "^5.27.0", "@typescript-eslint/parser": "^5.27.0", "eslint": "^8.16.0", @@ -22,6 +23,7 @@ "eslint-plugin-svelte3": "^4.0.0", "prettier": "^2.6.2", "prettier-plugin-svelte": "^2.7.0", + "sass": "^1.55.0", "sirv-cli": "^2.0.2", "svelte": "^3.44.0", "svelte-check": "^2.7.1", @@ -30,5 +32,9 @@ "typescript": "^4.7.4", "vite": "^3.0.0" }, - "type": "module" + "type": "module", + "dependencies": { + "asciidoctor": "^2.2.6", + "marked": "^4.1.1" + } } diff --git a/src/lib/components/atoms/DocsNavNode.svelte b/src/lib/components/atoms/DocsNavNode.svelte new file mode 100644 index 0000000..f9123a9 --- /dev/null +++ b/src/lib/components/atoms/DocsNavNode.svelte @@ -0,0 +1,29 @@ + + + +
  • +
    + {info.title} +
    +
    • + + diff --git a/src/lib/components/molecules/DocsNavTree.svelte b/src/lib/components/molecules/DocsNavTree.svelte new file mode 100644 index 0000000..abca754 --- /dev/null +++ b/src/lib/components/molecules/DocsNavTree.svelte @@ -0,0 +1,39 @@ + + +{#if nested} + + +{/if} + + + + diff --git a/src/lib/components/molecules/NavHost.svelte b/src/lib/components/molecules/NavHost.svelte index 1023266..f5a571c 100644 --- a/src/lib/components/molecules/NavHost.svelte +++ b/src/lib/components/molecules/NavHost.svelte @@ -28,17 +28,17 @@
    diff --git a/src/lib/documentation.scss b/src/lib/documentation.scss new file mode 100644 index 0000000..e366c09 --- /dev/null +++ b/src/lib/documentation.scss @@ -0,0 +1,45 @@ +#markup-content { + /* Defaults for text */ + color: var(--white); + font-weight: 300; + font-size: 1rem; + letter-spacing: 0.02rem; + padding: 100px 30px 0px 30px; + + a { + text-decoration: none; + color: var(--white); + border-bottom: 1.5px solid var(--accent-color); + padding: 0px 5px; + transition: all 0.4s var(--bezier-one); + } + + a:hover { + background-color: var(--accent-color); + border-radius: 6px; + color: var(--grey-four); + } + + code { + background-color: var(--grey-six); + border-radius: 4px; + padding: 2px; + } + + h4 { + margin-bottom: 0.5rem; + } + + h5 { + color: var(--accent-color); + } + + /* Markup processors output this for bold text, but css spec is goofy aah */ + strong { + font-weight: bold; + } + + ul { + padding-left: 2rem; + } +} diff --git a/src/lib/documentation.server.ts b/src/lib/documentation.server.ts new file mode 100644 index 0000000..dd05ab5 --- /dev/null +++ b/src/lib/documentation.server.ts @@ -0,0 +1,202 @@ +import { is_tree } from './documentation.shared'; +import type { Document, DocsTree, DocsTreeNode, DocumentInfo } from './documentation.shared'; + +import { browser, prerendering } from '$app/environment'; + +import fs, { existsSync as exists } from 'fs'; +import path from 'path'; + + +import { parse as parse_md } from 'marked'; +import AsciiDocProcessor from 'asciidoctor' + +// This file does not work in a browser. +if (browser) { + throw Error('SvelteKit has skill issues'); +} + +/// Constants + +const supported_formats: Map Document> = new Map(); + +supported_formats.set("md", markup => { + let lines = markup.split('\n'); + + // Get and remove the first line. + const first_line = lines.splice(0, 1)[0]; + // Remove `# `. + const title = first_line.substring(2); + + // Convert the rest to html + const content = parse_md(lines.join('\n')); + + return { title, content }; +}); + +const asciidoctor = AsciiDocProcessor(); +const adoc_fn = markup => { + // Get first line. + const first_line = markup.split('\n')[0]; + // Remove `= `. + const title = first_line.substring(2); + + // Convert it to html. Unlike markdown, we do not need to remove the first title heading. + // NOTE: Maybe consider change the safe mode value. + const content = asciidoctor.convert(markup, { doctype: "book" }) + + return { title, content }; +} + +supported_formats.set("adoc", adoc_fn) +supported_formats.set("asciidoc", adoc_fn) + +const supported_filetypes = [...supported_formats.keys()]; + +let docs_folder = process.env.REVANCED_DOCS_FOLDER; +if (docs_folder === undefined) { + if (prerendering) { console.warn("Using testing docs in production build") } + docs_folder = "testing-docs"; +} + +const ignored_items = ["assets", "README.md"]; + +/// Utility functions + +function is_directory(item: string) { + return fs.lstatSync(item).isDirectory(); +} + +function get_ext(fname: string) { + // Get extname and remove the first dot. + return path.extname(fname).substring(1); +} + +function get_slug_of_node(node: DocsTreeNode): string { + if (is_tree(node)) { + return node.index.slug; + } + + return node.slug; +} + +/// Important functions + +// Get a document. Returns null if it does not exist. +export function get(slug: string): Document|null { + let target = path.join(docs_folder, slug); + // Handle index file for folder. + if (exists(target) && is_directory(target)) { + target += "/index"; + } + + const dir = path.dirname(target); + if (!exists(dir)) { + return null; + } + + let full_path, ext, found = false; + // We are looking for the file `${target}.(any_supported_extension)`. Try to find it. + for (const item of fs.readdirSync(dir)) { + full_path = path.join(dir, item); + // Get file extension + ext = get_ext(item); + + // Unsupported/unrelated file. + if (!supported_formats.has(ext)) { + continue; + } + + const desired_path = `${target}.${ext}`; // Don't grab some other random supported file. + if (!is_directory(full_path) && desired_path == full_path) { + // We found it. + found = true; + break; + } + } + + if (!found) { + return null; + } + + // Process the file and return. + return supported_formats.get(ext)(fs.readFileSync(full_path, 'utf-8')); +} + +// Get file information +function process_file(fname: string): DocumentInfo { + // Remove docs folder prefix and file extension suffix, then split it. + const parts = fname + .substring(`${docs_folder}/`.length, fname.length - (get_ext(fname).length + 1)) + .split("/"); + + // Remove `index` suffix if present. + const last_index = parts.length - 1; + if (parts[last_index] == "index") { + parts.pop(); + } + + const slug = parts.join("/"); + const title = get(slug).title; + + return { slug, title }; +} + +// Returns a document tree. +function process_folder(dir: string): DocsTree { + let tree: DocsTree = { + index: null, + nodes: [] + }; + + // List everything in the directory. + const items = fs.readdirSync(dir); + + for (const item of items) { + if (ignored_items.includes(item) || [".", "_"].includes(item[0])) { + continue; + } + + const itemPath = path.join(dir, item); + + const is_dir = is_directory(itemPath); + let is_index_file = false; + + if (!is_dir) { + // Ignore files we cannot process. + if (!supported_formats.has(get_ext(item))) { + continue; + } + + for (const ext of supported_filetypes) { + if (item == `index.${ext}`) { + is_index_file = true; + } + } + } + + const node = is_dir ? process_folder(itemPath) : process_file(itemPath); + + if (is_index_file) { + tree.index = node; + } else { + tree.nodes.push(node); + } + } + + if (tree.index === null) { + throw Error(`${dir} has no index file.`); + } + + // `numeric: true` because we want to be able to specify + // the order if necessary by prepending a number to the file name. + tree.nodes.sort( + (a, b) => get_slug_of_node(a).localeCompare(get_slug_of_node(b), "en", { numeric: true }) + ); + + return tree; +} + +// Returns the document tree. +export function index_content(): DocsTree { + return process_folder(docs_folder); +} diff --git a/src/lib/documentation.shared.ts b/src/lib/documentation.shared.ts new file mode 100644 index 0000000..8042562 --- /dev/null +++ b/src/lib/documentation.shared.ts @@ -0,0 +1,28 @@ +/// Types + +export interface Document { + title: string; + // HTML + content: string; +} + +export interface DocumentInfo { + title: string; + slug: string; +} + +// A tree representing the `docs` folder. +export interface DocsTree { + // index.whatever + index: DocumentInfo; + // Everything except index.whatever + nodes: DocsTreeNode[]; +} + +export type DocsTreeNode = DocsTree | DocumentInfo; + +/// Functions + +export function is_tree(node: DocsTreeNode) { + return node.hasOwnProperty('nodes'); +} diff --git a/src/routes/docs/+layout.server.ts b/src/routes/docs/+layout.server.ts new file mode 100644 index 0000000..448fea8 --- /dev/null +++ b/src/routes/docs/+layout.server.ts @@ -0,0 +1,10 @@ +import type { PageServerLoad } from './$types'; + +import { index_content } from '$lib/documentation.server'; + +// The load function here used to get data from a json file created by a (prerendered) server route. +// This was because we could not prerender the documentation route before. +// If you can no longer prerender the docs, then you are going to have to move the load functions here to a prerendered server route like before and fetch them here. +export const prerender = true; + +export const load: PageServerLoad = () => ({ tree: index_content() }); diff --git a/src/routes/docs/+layout.svelte b/src/routes/docs/+layout.svelte new file mode 100644 index 0000000..ebbe13a --- /dev/null +++ b/src/routes/docs/+layout.svelte @@ -0,0 +1,34 @@ + + +
    +
    + +
    + +
    + + diff --git a/src/routes/docs/+page.svelte b/src/routes/docs/+page.svelte deleted file mode 100644 index fd1b9c6..0000000 --- a/src/routes/docs/+page.svelte +++ /dev/null @@ -1,126 +0,0 @@ - - - - ReVanced | Docs - - - - -
    -
    -
    -

    Prerequisites

    -
    -
    -

    Using ReVanced CLI and installiing ReVanced

    -
    -
    -
    -
    docs/prerequisites
    -
    -

    Requirements

    -
    -
      -
    • ADB
      • -
    • x86/x86_64 host architecture
      • -
    • Zulu JDK 17
      • -
    • Latest Android SDK if you plan to build the integrations from the source
      • -
    • - The APK file you want to patch (e.g. YouTube v17.36.37 or YouTube Music v5.23.50). If you - want to mount patched applications as root, make sure the same version is installed on - your device. -
      • -
    • - You can continue by either building everything from source or downloading the prebuilt - packages. -
      • -
    -
    - You can continue by either - building everything from source - or - downloading the prebuilt packages. -
    -
    -
    -
    - Using ReVanced CLI and installing ReVanced (Docs will be overhauled anyways) -
    -
    -
    - - diff --git a/src/routes/docs/[...slug]/+page.server.ts b/src/routes/docs/[...slug]/+page.server.ts new file mode 100644 index 0000000..0c80286 --- /dev/null +++ b/src/routes/docs/[...slug]/+page.server.ts @@ -0,0 +1,17 @@ +import type { PageServerLoad } from './$types'; +import { error } from '@sveltejs/kit'; + +import { get } from '$lib/documentation.server'; + +// See also: ../+layout.server.ts +export const prerender = true; + +export const load: PageServerLoad = ({ params }) => { + const document = get(params.slug); + if (document === null) { + error + throw error(404); + } + + return document; +} diff --git a/src/routes/docs/[...slug]/+page.svelte b/src/routes/docs/[...slug]/+page.svelte new file mode 100644 index 0000000..a26a162 --- /dev/null +++ b/src/routes/docs/[...slug]/+page.svelte @@ -0,0 +1,22 @@ + + + + ReVanced | Docs + + + + +
    +

    {data.title}

    + + {@html data.content} +
    diff --git a/testing-docs/adoc-format.adoc b/testing-docs/adoc-format.adoc new file mode 100644 index 0000000..0fdfcce --- /dev/null +++ b/testing-docs/adoc-format.adoc @@ -0,0 +1,10 @@ += AsciiDoc Example + += Another title + +*Bold text* + +== Section 1 + +* Item 1 +* Item 2 diff --git a/testing-docs/deeply/another-page.md b/testing-docs/deeply/another-page.md new file mode 100644 index 0000000..5ec36a1 --- /dev/null +++ b/testing-docs/deeply/another-page.md @@ -0,0 +1,4 @@ +# Another Page + +# Hello +Content! diff --git a/testing-docs/deeply/index.md b/testing-docs/deeply/index.md new file mode 100644 index 0000000..1251a54 --- /dev/null +++ b/testing-docs/deeply/index.md @@ -0,0 +1,4 @@ +# Nesting sample + +# First one +Text diff --git a/testing-docs/deeply/nested/content/index.md b/testing-docs/deeply/nested/content/index.md new file mode 100644 index 0000000..e8511a1 --- /dev/null +++ b/testing-docs/deeply/nested/content/index.md @@ -0,0 +1,4 @@ +# Nesting sample + +# Third one +Text diff --git a/testing-docs/deeply/nested/index.md b/testing-docs/deeply/nested/index.md new file mode 100644 index 0000000..547e6e4 --- /dev/null +++ b/testing-docs/deeply/nested/index.md @@ -0,0 +1,4 @@ +# Nesting sample + +# Second one +Text diff --git a/testing-docs/index.md b/testing-docs/index.md new file mode 100644 index 0000000..bee79c0 --- /dev/null +++ b/testing-docs/index.md @@ -0,0 +1,16 @@ +# Prerequisites +##### docs/prerequisites + +
    + +#### Requirements + +- ADB +- x86/x86\_64 host architecture +- Zulu JDK 17 +- Latest Android SDK if you plan to build the integrations from the source +- The APK file you want to patch (e.g. YouTube v17.36.37 or YouTube Music v5.23.50). If you want to mount patched applications as root, make sure the same version is installed on your device. + +
    + +You can continue by either [building everything from source](https://github.com/revanced/revanced-documentation/wiki/Building-from-source) or [downloading the prebuilt packages](https://github.com/revanced/revanced-documentation/wiki/Downloading-prebuilt-packages). diff --git a/testing-docs/markdown-format.md b/testing-docs/markdown-format.md new file mode 100644 index 0000000..1244a86 --- /dev/null +++ b/testing-docs/markdown-format.md @@ -0,0 +1,4 @@ +# Markdown Example +Text + +**Bold text** diff --git a/testing-docs/writing-docs.md b/testing-docs/writing-docs.md new file mode 100644 index 0000000..ae1446d --- /dev/null +++ b/testing-docs/writing-docs.md @@ -0,0 +1,9 @@ +# Writing documentation + +You can write documentation with markdown or asciidoc. + +## Title +The first line must be the `h1` equivalent of the markup language. +For markdown, this would be `# ` and `= <title>` for asciidoc. + +**The title part may or may not go through the markup processor depending on the language.** It is instead added by the website itself. From fb2185083c2b6736430d0910bf57977e3e4a9c13 Mon Sep 17 00:00:00 2001 From: Ax333l <main@axelen.xyz> Date: Fri, 4 Nov 2022 19:20:33 +0100 Subject: [PATCH 2/3] feat: add vercel routes config generator This is so we do not need to force trailing slashes. --- src/_vercel-moment.js | 82 +++++++++++++++++++++++++++++++++++++++++++ svelte.config.js | 8 ++--- 2 files changed, 86 insertions(+), 4 deletions(-) create mode 100644 src/_vercel-moment.js diff --git a/src/_vercel-moment.js b/src/_vercel-moment.js new file mode 100644 index 0000000..01e681c --- /dev/null +++ b/src/_vercel-moment.js @@ -0,0 +1,82 @@ +import fs from 'fs'; + +// This code was stolen from https://github.com/sveltejs/kit/blob/master/packages/adapter-static/platforms.js + +// sveltekit does things like this instead of actually just using ts for some reason. +/** @param {import('@sveltejs/kit').Builder} builder */ +function vercel_routes(builder) { + /** @type {any[]} */ + const routes = [ + { + src: `/${builder.config.kit.appDir}/immutable/.+`, + headers: { + 'cache-control': 'public, immutable, max-age=31536000' + } + } + ]; + + // explicit redirects + for (const [src, redirect] of builder.prerendered.redirects) { + routes.push({ + src, + headers: { + Location: redirect.location + }, + status: redirect.status + }); + } + + // prerendered pages + for (const [src, page] of builder.prerendered.pages) { + routes.push({ + src, + dest: `${builder.config.kit.appDir}/prerendered/${page.file}` + }); + } + + // implicit redirects (trailing slashes) + for (const [src] of builder.prerendered.pages) { + if (src !== '/') { + routes.push({ + src: src.endsWith('/') ? src.slice(0, -1) : src + '/', + headers: { + location: src + }, + status: 308 + }); + } + } + + routes.push({ + handle: 'filesystem' + }); + + return routes; +} + +export function wrap(adapter, opts) { + if (!process.env.VERCEL) { + // we don't have to bother :) + return adapter(opts); + } + + // Not exactly what adapter-static does, but it works. + opts.pages = '.vercel/output/static'; + + adapter = adapter(opts); + + const adapt_fn = adapter.adapt; + adapter.adapt = async (builder) => { + const result = await adapt_fn(builder); + fs.writeFileSync( + '.vercel/output/config.json', + JSON.stringify({ + version: 3, + routes: vercel_routes(builder) + }) + ); + return result; + } + + return adapter; +} diff --git a/svelte.config.js b/svelte.config.js index 55305a6..b5327fd 100644 --- a/svelte.config.js +++ b/svelte.config.js @@ -1,6 +1,8 @@ import adapter from '@sveltejs/adapter-static'; import preprocess from 'svelte-preprocess'; +import { wrap } from './src/_vercel-moment.js'; + /** @type {import('@sveltejs/kit').Config} */ const config = { // Consult https://github.com/sveltejs/svelte-preprocess @@ -9,13 +11,11 @@ const config = { kit: { // adapter-static has vercel detection, but that does not let you set a custom 404 page easily. - // Instead, we have to disable it and set trailing slash to always. - adapter: adapter({ + // Instead, we have to use a wrapper that generates a vercel config if on vercel... + adapter: wrap(adapter, { pages: "public", fallback: "404.html" }), - - trailingSlash: 'always' } }; From 90a3893977f61c7c419a0a026440e2596e3e8493 Mon Sep 17 00:00:00 2001 From: Ax333l <main@axelen.xyz> Date: Fri, 4 Nov 2022 19:21:55 +0100 Subject: [PATCH 3/3] chore: add ci build script --- ci-build.sh | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100755 ci-build.sh diff --git a/ci-build.sh b/ci-build.sh new file mode 100755 index 0000000..ae0c7e4 --- /dev/null +++ b/ci-build.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +set -e + +# CD to the directory of this script. +cd "$(dirname "$0")" + +docs_git_repo="${REVANCED_DOCS_REPO:-https://github.com/revanced/revanced-documentation.git}" +export REVANCED_DOCS_FOLDER="_docs_src" + +git clone "$docs_git_repo" "$REVANCED_DOCS_FOLDER" + +# Do this because the docs repo doesn't have any actual docs right now +cd "$REVANCED_DOCS_FOLDER" +cp README.md index.md +cd - + +# Copy assets from docs repo to here. +mkdir -p static/docs +cp -r "$REVANCED_DOCS_FOLDER"/assets static/docs/assets || true + +npm run build