From a1d97c2c913ada3a831a2ce0e45acb8a7d002102 Mon Sep 17 00:00:00 2001 From: "create-issue-branch[bot]" <53036503+create-issue-branch[bot]@users.noreply.github.com> Date: Tue, 23 Jul 2024 09:47:34 +0000 Subject: [PATCH 01/11] Create draft PR for #98 [skip ci] From de53e60ae5b99220765cd03b5611176419315d57 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen Date: Tue, 23 Jul 2024 12:37:55 -0700 Subject: [PATCH 02/11] docs cleanup and prep --- .changeset/dependencies-GH-103.md | 5 - .changeset/dependencies-GH-104.md | 5 - .changeset/dependencies-GH-112.md | 5 - .changeset/dependencies-GH-161.md | 5 - .changeset/dependencies-GH-60.md | 5 - .changeset/dependencies-GH-61.md | 5 - .changeset/dependencies-GH-63.md | 5 - .changeset/dependencies-GH-64.md | 5 - .changeset/dependencies-GH-89.md | 5 - .changeset/dependencies-GH-94.md | 5 - .changeset/dependencies-GH-95.md | 5 - pnpm-lock.yaml | 140 ++++++++++++++++++ pnpm-workspace.yaml | 1 + www/assets/studioCMS-dark.png | Bin 0 -> 4893 bytes www/docs/astro.config.mts | 6 +- www/docs/package.json | 1 + www/docs/src/components/Youtube.astro | 13 ++ .../content-renderer.md | 0 .../dashboard.md | 0 .../date-locale.md | 0 .../db-start-page.md | 0 .../image-service.md | 0 .../included-integrations.md | 0 .../marked-config.md | 0 .../overrides.md | 0 .../verbose.md | 0 www/docs/src/content/docs/index.mdx | 9 +- .../content/docs/plugins/studiocms-blog.mdx | 3 - .../docs/start-here/getting-started.mdx | 11 +- 29 files changed, 173 insertions(+), 66 deletions(-) delete mode 100644 .changeset/dependencies-GH-103.md delete mode 100644 .changeset/dependencies-GH-104.md delete mode 100644 .changeset/dependencies-GH-112.md delete mode 100644 .changeset/dependencies-GH-161.md delete mode 100644 .changeset/dependencies-GH-60.md delete mode 100644 .changeset/dependencies-GH-61.md delete mode 100644 .changeset/dependencies-GH-63.md delete mode 100644 .changeset/dependencies-GH-64.md delete mode 100644 .changeset/dependencies-GH-89.md delete mode 100644 .changeset/dependencies-GH-94.md delete mode 100644 .changeset/dependencies-GH-95.md create mode 100644 www/assets/studioCMS-dark.png create mode 100644 www/docs/src/components/Youtube.astro rename www/docs/src/content/docs/{reference => config-reference}/content-renderer.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/dashboard.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/date-locale.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/db-start-page.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/image-service.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/included-integrations.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/marked-config.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/overrides.md (100%) rename www/docs/src/content/docs/{reference => config-reference}/verbose.md (100%) diff --git a/.changeset/dependencies-GH-103.md b/.changeset/dependencies-GH-103.md deleted file mode 100644 index 68fde374c..000000000 --- a/.changeset/dependencies-GH-103.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docs": patch ---- - -fix(deps): update dependency @astrojs/starlight to ^0.24.4 diff --git a/.changeset/dependencies-GH-104.md b/.changeset/dependencies-GH-104.md deleted file mode 100644 index a3ea3f6a6..000000000 --- a/.changeset/dependencies-GH-104.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrolicious/studiocms": patch ---- - -fix(deps): update dependency @iconify-json/mdi to ^1.1.67 diff --git a/.changeset/dependencies-GH-112.md b/.changeset/dependencies-GH-112.md deleted file mode 100644 index 4f7338ac9..000000000 --- a/.changeset/dependencies-GH-112.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrolicious/studiocms-blog": patch ---- - -fix(deps): update dependency @astrojs/rss to ^4.0.7 diff --git a/.changeset/dependencies-GH-161.md b/.changeset/dependencies-GH-161.md deleted file mode 100644 index 3d9f066be..000000000 --- a/.changeset/dependencies-GH-161.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrolicious/studiocms": patch ---- - -fix(deps): update dependency @inox-tools/runtime-logger to ^0.2.0 diff --git a/.changeset/dependencies-GH-60.md b/.changeset/dependencies-GH-60.md deleted file mode 100644 index bf0164d48..000000000 --- a/.changeset/dependencies-GH-60.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docs": patch ---- - -fix(deps): update dependency astro to ^4.9.3 diff --git a/.changeset/dependencies-GH-61.md b/.changeset/dependencies-GH-61.md deleted file mode 100644 index 7b1255e05..000000000 --- a/.changeset/dependencies-GH-61.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"web": patch ---- - -fix(deps): update dependency astro to ^4.9.3 diff --git a/.changeset/dependencies-GH-63.md b/.changeset/dependencies-GH-63.md deleted file mode 100644 index 08b179dec..000000000 --- a/.changeset/dependencies-GH-63.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"cloudflare-playground": patch ---- - -fix(deps): update astro monorepo diff --git a/.changeset/dependencies-GH-64.md b/.changeset/dependencies-GH-64.md deleted file mode 100644 index d0859814d..000000000 --- a/.changeset/dependencies-GH-64.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"node-playground": patch ---- - -fix(deps): update astro monorepo diff --git a/.changeset/dependencies-GH-89.md b/.changeset/dependencies-GH-89.md deleted file mode 100644 index 7be5af08f..000000000 --- a/.changeset/dependencies-GH-89.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrolicious/studiocms": patch ---- - -fix(deps): update dependency @astrojs/markdown-remark to ^5.1.1 diff --git a/.changeset/dependencies-GH-94.md b/.changeset/dependencies-GH-94.md deleted file mode 100644 index cfd11796d..000000000 --- a/.changeset/dependencies-GH-94.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docs": patch ---- - -fix(deps): update dependency @astrojs/starlight to ^0.24.1 diff --git a/.changeset/dependencies-GH-95.md b/.changeset/dependencies-GH-95.md deleted file mode 100644 index dbbfbf549..000000000 --- a/.changeset/dependencies-GH-95.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrolicious/studiocms": patch ---- - -fix(deps): update dependency @iconify/utils to ^2.1.25 diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c2e95386c..0e5f795fb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -58,6 +58,9 @@ catalogs: '@shoelace-style/shoelace': specifier: ^2.15.1 version: 2.15.1 + astro-embed: + specifier: ^0.7.2 + version: 0.7.2 starlight-links-validator: specifier: ^0.9.1 version: 0.9.1 @@ -452,6 +455,9 @@ importers: astro: specifier: 'catalog:' version: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + astro-embed: + specifier: catalog:docs + version: 0.7.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) sharp: specifier: 'catalog:' version: 0.33.4 @@ -530,6 +536,32 @@ packages: '@antfu/utils@0.7.10': resolution: {integrity: sha512-+562v9k4aI80m1+VuMHehNJWLOFjBnXn3tdOitzD0il5b7smkSBal4+a3oKiQTbrwMmN/TBUMDvbdoWDehgOww==} + '@astro-community/astro-embed-integration@0.7.1': + resolution: {integrity: sha512-uPpVx/CluktB3nOnCTUB7tQ3jms2acYWTe/JgX5tFqTjjtiL686+FcjOaQ/Ej+FNErdg+36Y66WTeIxlYw4pvQ==} + peerDependencies: + astro: ^2.0.0 || ^3.0.0-beta || ^4.0.0-beta + + '@astro-community/astro-embed-link-preview@0.2.1': + resolution: {integrity: sha512-pl+KYhv5l2VpvvSwmZXTrCV+x3FxY3js4FX7/V/ABpLiSUsgF0yno90m0qd4Hx2y0XoeC4b/TB4T/Eu4AQIBTQ==} + + '@astro-community/astro-embed-twitter@0.5.4': + resolution: {integrity: sha512-wQyros0Uh4L8fDOCZ9+UYMoq4u+YiJZEvjnL6ZP0KL6dcsyfma/XC2/Q2DBL5SBBiIkkFcFHmzDBIPl4HsENXw==} + peerDependencies: + astro: ^2.0.0 || ^3.0.0-beta || ^4.0.0-beta + + '@astro-community/astro-embed-utils@0.1.3': + resolution: {integrity: sha512-eiMO+vfCdE9GtW6qE7X5Xl6YCKZDCoXJEWqRofQcoC3GHjqN2/WhJlnaxNVRq3demSO03UNtho57Em5p7o7AOA==} + + '@astro-community/astro-embed-vimeo@0.3.7': + resolution: {integrity: sha512-0Y08IOudqSLC/RKiYZagaG/uvfblSt7of+hrIcRky7u+KZK3VrTbZ/Np+nIq81jXLGJQPXN8TNGsOUsY0mw9lw==} + peerDependencies: + astro: ^2.0.0 || ^3.0.0-beta || ^4.0.0-beta + + '@astro-community/astro-embed-youtube@0.5.2': + resolution: {integrity: sha512-cckWcq7mFCmI6uPpIlRolSafSQRYZBOaxIc8DaCUh8+JQAtPF7O4EdpRpZBUcvbARrWEEyHJCWrt0XOGppMniw==} + peerDependencies: + astro: ^2.0.0 || ^3.0.0-beta || ^4.0.0-beta + '@astrojs/check@0.5.10': resolution: {integrity: sha512-vliHXM9cu/viGeKiksUM4mXfO816ohWtawTl2ADPgTsd4nUMjFiyAl7xFZhF34yy4hq4qf7jvK1F2PlR3b5I5w==} hasBin: true @@ -2157,6 +2189,9 @@ packages: '@types/node@17.0.45': resolution: {integrity: sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==} + '@types/node@18.19.42': + resolution: {integrity: sha512-d2ZFc/3lnK2YCYhos8iaNIYu9Vfhr92nHiyJHRltXWjXUBjEE+A4I58Tdbnw4VhggSW+2j5y5gTrLs4biNnubg==} + '@types/node@20.14.11': resolution: {integrity: sha512-kprQpL8MMeszbz6ojB5/tU8PLN4kesnN8Gjzw349rDlNgsSzg90lAVj3llK99Dh7JON+t9AuscPPFW6mPbTnSA==} @@ -2403,6 +2438,17 @@ packages: resolution: {integrity: sha512-ISvCdHdlTDlH5IpxQJIex7BWBywFWgjJSVdwst+/iQCoEYnyOaQ95+X1JGshuBjGp6nxKUy1jMgE3zPqN7fQdg==} hasBin: true + astro-auto-import@0.4.2: + resolution: {integrity: sha512-ZgWZQ58+EhbEym1+aoUnNyECOy0wsG5uRUs+rVp/7BzHtj1V76J2qkhjaTWLplgNb+8WrzhvTQNxytmXRCW+Ow==} + engines: {node: '>=16.0.0'} + peerDependencies: + astro: ^2.0.0 || ^3.0.0-beta || ^4.0.0-beta + + astro-embed@0.7.2: + resolution: {integrity: sha512-v/j6yRA9Wa+TEHBV64dQU5bLKuYiy1mNudiKIM+nvFe1bAUh+4wzQOf3lRofrxyBMgHaZbr8Xy7oLS9PVzu5jg==} + peerDependencies: + astro: ^2.0.0 || ^3.0.0-beta || ^4.0.0-beta + astro-expressive-code@0.35.3: resolution: {integrity: sha512-f1L1m3J3EzZHDEox6TXmuKo5fTSbaNxE/HU0S0UQmvlCowtOKnU/LOsoDwsbQSYGKz+fdLRPsCjFMiKqEoyfcw==} peerDependencies: @@ -2691,6 +2737,9 @@ packages: css-select@5.1.0: resolution: {integrity: sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==} + css-selector-parser@1.4.1: + resolution: {integrity: sha512-HYPSb7y/Z7BNDCOrakL4raGO2zltZkbeXyAd6Tg9obzix6QhzxCotdBl6VT0Dv4vZfJGVz3WL/xaEI9Ly3ul0g==} + css-selector-parser@3.0.5: resolution: {integrity: sha512-3itoDFbKUNx1eKmVpYMFyqKX04Ww9osZ+dLgrk6GEv6KMVeXUhUnp4I5X+evw+u3ZxVU6RFXSSRxlTeMh8bA+g==} @@ -2718,6 +2767,9 @@ packages: resolution: {integrity: sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==} engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0, npm: '>=7.0.0'} + cssom@0.5.0: + resolution: {integrity: sha512-iKuQcq+NdHqlAcwUY0o/HL69XQrUaQdMjmStJ8JFmUaiiQErlhrmuigkg/CU4E2J0IyUKUrMAgl36TvN67MqTw==} + csstype@3.1.3: resolution: {integrity: sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==} @@ -3526,6 +3578,9 @@ packages: lines-and-columns@1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + linkedom@0.14.26: + resolution: {integrity: sha512-mK6TrydfFA7phrnp+1j57ycBwFI5bGSW6YXlw9acHoqF+mP/y+FooEYYyniOt5Ot57FSKB3iwmnuQ1UUyNLm5A==} + linkify-it@5.0.0: resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} @@ -3538,6 +3593,9 @@ packages: lit@3.1.4: resolution: {integrity: sha512-q6qKnKXHy2g1kjBaNfcoLlgbI3+aSOZ9Q4tiGa9bGYXq5RBXxkVTqTIVmP2VWMp29L4GyvCFm8ZQ2o56eUAMyA==} + lite-youtube-embed@0.3.2: + resolution: {integrity: sha512-b1dgKyF4PHhinonmr3PB172Nj0qQgA/7DE9EmeIXHR1ksnFEC2olWjNJyJGdsN2cleKHRjjsmrziKlwXtPlmLQ==} + load-yaml-file@0.2.0: resolution: {integrity: sha512-OfCBkGEw4nN6JLtgRidPX6QxjBQGQf72q3si2uvqyFEMbycSFFHwAZeXx6cJgFM9wmLrf9zBwCP3Ivqa+LLZPw==} engines: {node: '>=6'} @@ -4695,6 +4753,9 @@ packages: ufo@1.5.4: resolution: {integrity: sha512-UsUk3byDzKd04EyoZ7U4DOlxQaD14JUKQl6/P7wiX4FNvUfm3XL246n9W5AmqwW5RSFJ27NAuM0iLscAOYUiGQ==} + uhyphen@0.2.0: + resolution: {integrity: sha512-qz3o9CHXmJJPGBdqzab7qAYuW8kQGKNEuoHFYrBwV6hWIMcpAmxDLXojcHfFr9US1Pe6zUswEIJIbLI610fuqA==} + unconfig@0.3.13: resolution: {integrity: sha512-N9Ph5NC4+sqtcOjPfHrRcHekBCadCXWTBzp2VYYbySOHW0PfD9XLCeXshTXjkPYwLrBr9AtSeU0CZmkYECJhng==} @@ -4729,6 +4790,9 @@ packages: unist-util-remove-position@5.0.0: resolution: {integrity: sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==} + unist-util-select@4.0.3: + resolution: {integrity: sha512-1074+K9VyR3NyUz3lgNtHKm7ln+jSZXtLJM4E22uVuoFn88a/Go2pX8dusrt/W+KWH1ncn8jcd8uCQuvXb/fXA==} + unist-util-stringify-position@4.0.0: resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} @@ -5040,6 +5104,40 @@ snapshots: '@antfu/utils@0.7.10': {} + '@astro-community/astro-embed-integration@0.7.1(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3))': + dependencies: + '@astro-community/astro-embed-link-preview': 0.2.1 + '@astro-community/astro-embed-twitter': 0.5.4(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + '@astro-community/astro-embed-vimeo': 0.3.7(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + '@astro-community/astro-embed-youtube': 0.5.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + '@types/unist': 2.0.10 + astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + astro-auto-import: 0.4.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + unist-util-select: 4.0.3 + + '@astro-community/astro-embed-link-preview@0.2.1': + dependencies: + '@astro-community/astro-embed-utils': 0.1.3 + + '@astro-community/astro-embed-twitter@0.5.4(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3))': + dependencies: + '@astro-community/astro-embed-utils': 0.1.3 + astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + + '@astro-community/astro-embed-utils@0.1.3': + dependencies: + linkedom: 0.14.26 + + '@astro-community/astro-embed-vimeo@0.3.7(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3))': + dependencies: + '@astro-community/astro-embed-utils': 0.1.3 + astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + + '@astro-community/astro-embed-youtube@0.5.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3))': + dependencies: + astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + lite-youtube-embed: 0.3.2 + '@astrojs/check@0.5.10(typescript@5.5.3)': dependencies: '@astrojs/language-server': 2.12.1(typescript@5.5.3) @@ -6832,6 +6930,10 @@ snapshots: '@types/node@17.0.45': {} + '@types/node@18.19.42': + dependencies: + undici-types: 5.26.5 + '@types/node@20.14.11': dependencies: undici-types: 5.26.5 @@ -7169,6 +7271,21 @@ snapshots: astring@1.8.6: {} + astro-auto-import@0.4.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)): + dependencies: + '@types/node': 18.19.42 + acorn: 8.12.1 + astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + + astro-embed@0.7.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)): + dependencies: + '@astro-community/astro-embed-integration': 0.7.1(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + '@astro-community/astro-embed-link-preview': 0.2.1 + '@astro-community/astro-embed-twitter': 0.5.4(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + '@astro-community/astro-embed-vimeo': 0.3.7(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + '@astro-community/astro-embed-youtube': 0.5.2(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)) + astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) + astro-expressive-code@0.35.3(astro@4.12.2(@types/node@20.14.11)(typescript@5.5.3)): dependencies: astro: 4.12.2(@types/node@20.14.11)(typescript@5.5.3) @@ -7533,6 +7650,8 @@ snapshots: domutils: 3.1.0 nth-check: 2.1.1 + css-selector-parser@1.4.1: {} + css-selector-parser@3.0.5: {} css-selector-tokenizer@0.8.0: @@ -7558,6 +7677,8 @@ snapshots: dependencies: css-tree: 2.2.1 + cssom@0.5.0: {} + csstype@3.1.3: {} culori@3.3.0: {} @@ -8403,6 +8524,14 @@ snapshots: lines-and-columns@1.2.4: {} + linkedom@0.14.26: + dependencies: + css-select: 5.1.0 + cssom: 0.5.0 + html-escaper: 3.0.3 + htmlparser2: 8.0.2 + uhyphen: 0.2.0 + linkify-it@5.0.0: dependencies: uc.micro: 2.1.0 @@ -8423,6 +8552,8 @@ snapshots: lit-element: 4.0.6 lit-html: 3.1.4 + lite-youtube-embed@0.3.2: {} + load-yaml-file@0.2.0: dependencies: graceful-fs: 4.2.11 @@ -9974,6 +10105,8 @@ snapshots: ufo@1.5.4: {} + uhyphen@0.2.0: {} + unconfig@0.3.13: dependencies: '@antfu/utils': 0.7.10 @@ -10032,6 +10165,13 @@ snapshots: '@types/unist': 3.0.2 unist-util-visit: 5.0.0 + unist-util-select@4.0.3: + dependencies: + '@types/unist': 2.0.10 + css-selector-parser: 1.4.1 + nth-check: 2.1.1 + zwitch: 2.0.4 + unist-util-stringify-position@4.0.0: dependencies: '@types/unist': 3.0.2 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 12326a2c8..251230594 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -33,6 +33,7 @@ catalogs: astro-seo: ^0.8.4 docs: '@shoelace-style/shoelace': ^2.15.1 + astro-embed: ^0.7.2 starlight-links-validator: ^0.9.1 starlight-package-managers: ^0.6.0 starlight-typedoc: ^0.13.0 diff --git a/www/assets/studioCMS-dark.png b/www/assets/studioCMS-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..7c78e03108f4d221375c1db2cf1fa68d0b908cb9 GIT binary patch literal 4893 zcmeI0YgAKL8isd56c7*&Z7G$Aa8PLr0(KBmxoa>AqKHOQAQ(hN$|ax;&?pjbcqkQ_ znIaUB&?=}gh9E*P+|q*5sfE~ZD+1xB(hvxwgo^~oZ2aFfYv$*yp0%>hZJ)if_j$kf zd%lwyypLkCX5AV9fXSZSPepwPOM92xoTeIb;C0a|XvT0L(k~ko^v& z7EScW^0%bWTZRUHk&nj71d4IJD|o-#U8mo9a9H)=l#$7YzY$z~&5YF{1`!5N3CFO^ zi^J=W)e!t`u!|qs{OVhC`KQuDW>XhU9&PI*ke&LYSzSLQ=Y6a8msa>2#m_}(7rXfb z({*Eox+12mxXPzL_T&Qt_;>!BjYg*`a5=xwUsR`^8kn2o@y0Y5sY+wRkYmVd4LSgH>wH8qu(Yu%SC~V!M zZ)pI{J*d5?vZ`vP7@L>N!Z_c%p~Eer>gt5X+FGp&vkWj5e}n^pU%dS3?|-`*nR=Am zSEaFFobWsq8>?JfTU*P7W0Vnq_X}7}GzD6J1 zxE)jAlZD;+Mvmk2l}fR93N^u)A85*9J$G&W6j8sFd2n)*KSU#F>}EqexG^&KlnVeox%2Q09TwF@9*Mia$Gm)!fyrWqeXhW&2(RoD-=b3Y_GNL)4kyvHV=QEnsjn zB5Q=2)r^qpla)PhN+|~5H}1!1+ecpb{G#DoE!i+mk9uD+z5b; z?O#p)mvwpc85=l6SH|~h$;~}YE^(A%-7fDAR)6C+*0{un$G=P(?e*xZo*2H!df*-PLqVyUes3&Mp;!;0&<)q+6kvD=L2vQOHO22X|TP?LB_>td`H?$=98q z*Sl>G{ieY>Aly#y#mDz9lgWLzG;6`( zt6+D@q}D!H4kVu=K*_A+@hEUED<`q4`S-P{vJ%;?R7&Ec_f zGPzVA2-yV5!u0w^u;}x@Ea_ir{0~tYf5TcxxdVNqJJPbcC8;Ra`phSe7Fnj0=53`Z zKxkcN4rb!qYD;)LdvY_p3U%3mAXI8DJ^3H5L1%OVrFSS>A1EU`^-2pdOT48ky)+zY28qe7s6>4^h95Bn2pJflzgLGbkwg(vMt3g+m_~evC`Z z!%}xC5RmgEfZ*F(-AF`44)uEAA?*sdn-Q71W98N!HGrnCj}EKg#C$hD(X&CVgV_Ka zuUvym*JR4P4; zt>@xJrLK3V_X85|@$vC4R5gUJF^|u60ngKIpgd}H`N7o9pN^E|? zd=$jSMMaIUkgeaq++>6Dc;asF>=|Fyl6-7`^k#}2T6f|)e?K5vXNclMe+~=(RRURH5x&!QAL?{?6yeW5Wl{%@}MItGA#xOfdcHe~6!2Ht> zMo4Z$leT+9sMIX6pcXExB7gAC1@_PdU6f^phkMZUqCk0GQL_B?&6_u+l;%;>u>~M% z4g-nP#XYXAmjbT?(ua7EAm2r<+ls1!*#;6nGcffajnZ3Po@sRqFd+KPyTRG+ZFhBs z(Z}c^fWC);kn190_&wVQ1`k7>JPvBF+wS?P9^ViLMDlicH;_#H$cw;egsoS%Od8JH zUpK%XvG%f3t|7lp9RB=Hb$(%Uf1C$8Xi zJIp%^E19lTAJ?~Tg_!m=xh#eb%pKVlG<^XwQyu)}OmzU^_jRNnPE#TLQK_T;&C`Wt zkDXA#x)$|UJl=ApK-l#X%@n0i3eS^)#}gaRQt;#`oz!ooWf>Qg@1 zBegfSucpP0kQ(gJ1)0Z6=jcL1V|#=&Aug^i^4l=ZOm#(tIH`mCDusT6=8Ox7VRKGQM3~{^wH)e)$1}F8I;tn;#zz)~aHMub-FdTSUY& zb}TfczdYZz!HcaqI6{gbS{o4>db;g~hgX8_8|xqcWd}CjhBm2rwObX%5;?C-hbihz7D&ik;ThR((pd_J+_fUoe-DkRVU5pq(qx zm_fpG*$TzK_=%vhvT|A>P)AUa(6tY)*z2i$8|AT)sIDKRbz$&RS;JAxXb;mWhLd^z=n5zw!e34vjZVJ_|D7#H>SyJ>4gO z@Q4bRUk0sp-SQ-n;{_+if)i`}j7$KMn;~b0C56BX-7Z!n5=ouBR&zQborb-K z?4QsszXP4CZR8>-vH_=m!!RzNHzq5K5ybV*x~~*gL$@yDWPhCSeY^!7=GqPa6TamG z)Xq*8Jtb{GI+Ec`yqH@>b9BnWqDoUFhah(O9;n1fK4@Dx&nh(0GJ~X+3V(i4T`yIa z*Q}bAg#B4a{Z)451gpVa-k4Zs#ZlZ-F1(OgF@F9^-;sx@HVL;svWO6=oum&Tf z^VP8MJ)Mkx@8E?me3EQ`3kDLu)a_+$= zkqYQO@vx$4uXz0U%~LqS*kN0Mq7jGLz{P|`Zyfpk*IT*>w*KD!0D|OLMe2TXT_dc* zXJ*oLi?H>2J{gdq+bn&JO@%v8P1Jo}K?@IM6Zn^|$@KQssKm;K)ALh9{XCx2$Mvgd zd$=%PCm};kO$7-d;FOt}9WB^L8}{vyJ(;a@TU+fw;{e zdwQYPRtRN{6u0)NC6edg%uS)s6=3u1o==7H%?NN$x*Jn)1|9Ab3ntx+oBocG!rAY_ yv`v?48+2o&?7R&g$>Vm2`e>;;{6O$uZNYLKh_!!%=_xzkKDx($A6c-2aq-{r^aX+d literal 0 HcmV?d00001 diff --git a/www/docs/astro.config.mts b/www/docs/astro.config.mts index 5de0c2e84..7c12bdd23 100644 --- a/www/docs/astro.config.mts +++ b/www/docs/astro.config.mts @@ -35,6 +35,7 @@ const makeTypeDocOptions = ( readme, jsDocCompatibility: true, skipErrorChecking: true, + sourceLinkTemplate: 'https://github.com/astrolicious/studiocms/tree/main/{path}#L{line}' }, } as StarlightTypeDocOptions; } @@ -61,6 +62,7 @@ export default defineConfig({ social: { github: "https://github.com/astrolicious/studiocms", discord: "https://chat.astrolicious.dev", + youtube: "https://www.youtube.com/@AstroStudioCMS" }, customCss: [ // Relative path to your custom CSS file @@ -196,8 +198,8 @@ export default defineConfig({ ], }, { - label: "Reference", - autogenerate: { directory: "reference" }, + label: "Configuration Reference", + autogenerate: { directory: "config-reference" }, collapsed: true, }, { diff --git a/www/docs/package.json b/www/docs/package.json index 7c96fc786..615af88cf 100644 --- a/www/docs/package.json +++ b/www/docs/package.json @@ -14,6 +14,7 @@ "@astrojs/starlight": "catalog:", "@shoelace-style/shoelace": "catalog:docs", "astro": "catalog:", + "astro-embed": "catalog:docs", "sharp": "catalog:", "starlight-links-validator": "catalog:docs", "starlight-package-managers": "catalog:docs", diff --git a/www/docs/src/components/Youtube.astro b/www/docs/src/components/Youtube.astro new file mode 100644 index 000000000..d00a80a69 --- /dev/null +++ b/www/docs/src/components/Youtube.astro @@ -0,0 +1,13 @@ +--- +import { YouTube } from 'astro-embed'; +--- +{/* + @jdtjenkins Because i know your going to complain about the center tag... the only way i could get the Youtube Embed to center was to wrap it in a center tag. I tried using the style tag but it didn't work. If you know a better way to center the video please let me know. + + This is partially due to the internal CSS provided by astro-embed. As well as Starlight CSS + + - @adammatthiesen +*/} +
+ +
diff --git a/www/docs/src/content/docs/reference/content-renderer.md b/www/docs/src/content/docs/config-reference/content-renderer.md similarity index 100% rename from www/docs/src/content/docs/reference/content-renderer.md rename to www/docs/src/content/docs/config-reference/content-renderer.md diff --git a/www/docs/src/content/docs/reference/dashboard.md b/www/docs/src/content/docs/config-reference/dashboard.md similarity index 100% rename from www/docs/src/content/docs/reference/dashboard.md rename to www/docs/src/content/docs/config-reference/dashboard.md diff --git a/www/docs/src/content/docs/reference/date-locale.md b/www/docs/src/content/docs/config-reference/date-locale.md similarity index 100% rename from www/docs/src/content/docs/reference/date-locale.md rename to www/docs/src/content/docs/config-reference/date-locale.md diff --git a/www/docs/src/content/docs/reference/db-start-page.md b/www/docs/src/content/docs/config-reference/db-start-page.md similarity index 100% rename from www/docs/src/content/docs/reference/db-start-page.md rename to www/docs/src/content/docs/config-reference/db-start-page.md diff --git a/www/docs/src/content/docs/reference/image-service.md b/www/docs/src/content/docs/config-reference/image-service.md similarity index 100% rename from www/docs/src/content/docs/reference/image-service.md rename to www/docs/src/content/docs/config-reference/image-service.md diff --git a/www/docs/src/content/docs/reference/included-integrations.md b/www/docs/src/content/docs/config-reference/included-integrations.md similarity index 100% rename from www/docs/src/content/docs/reference/included-integrations.md rename to www/docs/src/content/docs/config-reference/included-integrations.md diff --git a/www/docs/src/content/docs/reference/marked-config.md b/www/docs/src/content/docs/config-reference/marked-config.md similarity index 100% rename from www/docs/src/content/docs/reference/marked-config.md rename to www/docs/src/content/docs/config-reference/marked-config.md diff --git a/www/docs/src/content/docs/reference/overrides.md b/www/docs/src/content/docs/config-reference/overrides.md similarity index 100% rename from www/docs/src/content/docs/reference/overrides.md rename to www/docs/src/content/docs/config-reference/overrides.md diff --git a/www/docs/src/content/docs/reference/verbose.md b/www/docs/src/content/docs/config-reference/verbose.md similarity index 100% rename from www/docs/src/content/docs/reference/verbose.md rename to www/docs/src/content/docs/config-reference/verbose.md diff --git a/www/docs/src/content/docs/index.mdx b/www/docs/src/content/docs/index.mdx index 0c10d2cd5..170f9e5f6 100644 --- a/www/docs/src/content/docs/index.mdx +++ b/www/docs/src/content/docs/index.mdx @@ -5,8 +5,9 @@ template: splash hero: tagline: A dedicated CMS for Astro Studio. Built from the ground up by the Astro community. image: - file: ../../../../assets/studioCMS.png - alt: Astro StudioCMS + alt: Astro StudioCMS Logo + dark: ../../../../assets/studioCMS.png + light: ../../../../assets/studioCMS-dark.png actions: - text: Get started link: /start-here/getting-started @@ -16,3 +17,7 @@ hero: link: https://github.com/astrolicious/studiocms icon: github --- + +import Youtube from '~/components/Youtube.astro' + + \ No newline at end of file diff --git a/www/docs/src/content/docs/plugins/studiocms-blog.mdx b/www/docs/src/content/docs/plugins/studiocms-blog.mdx index 01510db92..f636c8369 100644 --- a/www/docs/src/content/docs/plugins/studiocms-blog.mdx +++ b/www/docs/src/content/docs/plugins/studiocms-blog.mdx @@ -1,9 +1,6 @@ --- title: "@astrolicious/studiocms-blog" description: "StudioCMS Blog Integration" -banner: - content: | - StudioCMS-Blog does not yet have a public release. This documentation is a preview of what's to come. --- import { PackageManagers } from 'starlight-package-managers'; diff --git a/www/docs/src/content/docs/start-here/getting-started.mdx b/www/docs/src/content/docs/start-here/getting-started.mdx index 2732cd988..2e5d5cb23 100644 --- a/www/docs/src/content/docs/start-here/getting-started.mdx +++ b/www/docs/src/content/docs/start-here/getting-started.mdx @@ -1,9 +1,6 @@ --- title: Getting Started with Astro StudioCMS description: Get started building with Astro StudioCMS. -banner: - content: | - StudioCMS does not yet have a public release. This documentation is a preview of what's to come. --- import { PackageManagers } from 'starlight-package-managers'; @@ -19,6 +16,12 @@ To start using Astro StudioCMS, you'll need: ## Creating an Astro Studio account +:::note +Currently, Astro Studio is in closed beta, and you'll need an invite to create an account. + +While we understand this may be frustrating, we're following Astro Studio's News and Updates for the latest information on when the platform will be available to the public again. There is also an open [PR for `@astrojs/db`](https://github.com/withastro/astro/pull/11385) that would allow you to use the Astro StudioCMS integration without the need for Astro Studio by using another LibSQL database service or even self-hosted. +::: + You can create an Astro Studio account by visiting [Astro Studio](https://studio.astro.build/). Once created, you'll be able to access the Astro Studio dashboard and manage your projects. @@ -103,6 +106,6 @@ Now that you have Astro StudioCMS installed, you can start building your project Check out how to set environment variables in Astro StudioCMS by heading to [Environment Variables](/start-here/environment-variables). {/* TODO: Update the link when reference is started to look good */} -To learn more about the API and how to use Astro StudioCMS, check out the [Astro StudioCMS Reference](/reference/example). +To learn more about the API and how to use Astro StudioCMS, check out the [Astro StudioCMS Reference](/typedoc/studiocms-core/index/functions/studiocmscoreintegration/). You can also learn more about themes and how to author them by using [Astro Theme Provider](https://astro-theme-provider.netlify.app/). \ No newline at end of file From c7071745070f249f6377a671bdd1eafaddbb565e Mon Sep 17 00:00:00 2001 From: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Date: Tue, 23 Jul 2024 13:34:45 -0700 Subject: [PATCH 03/11] Update www/docs/src/content/docs/start-here/getting-started.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> --- www/docs/src/content/docs/start-here/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/docs/src/content/docs/start-here/getting-started.mdx b/www/docs/src/content/docs/start-here/getting-started.mdx index 2e5d5cb23..7e640c924 100644 --- a/www/docs/src/content/docs/start-here/getting-started.mdx +++ b/www/docs/src/content/docs/start-here/getting-started.mdx @@ -19,7 +19,7 @@ To start using Astro StudioCMS, you'll need: :::note Currently, Astro Studio is in closed beta, and you'll need an invite to create an account. -While we understand this may be frustrating, we're following Astro Studio's News and Updates for the latest information on when the platform will be available to the public again. There is also an open [PR for `@astrojs/db`](https://github.com/withastro/astro/pull/11385) that would allow you to use the Astro StudioCMS integration without the need for Astro Studio by using another LibSQL database service or even self-hosted. +While we understand this may be frustrating, we're following Astro Studio's News and Updates for the latest information on when the platform will be available to the public again. There is also an open [PR for `@astrojs/db`](https://github.com/withastro/astro/pull/11385) that would allow you to use the Astro StudioCMS integration without the need for Astro Studio by using another LibSQL database service or even self-hosted. ::: You can create an Astro Studio account by visiting [Astro Studio](https://studio.astro.build/). From 0e24fbb3250c580bac41e085d61ae52db2b8a4cf Mon Sep 17 00:00:00 2001 From: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Date: Tue, 23 Jul 2024 14:01:14 -0700 Subject: [PATCH 04/11] Update www/docs/src/content/docs/start-here/getting-started.mdx Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com> --- www/docs/src/content/docs/start-here/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/docs/src/content/docs/start-here/getting-started.mdx b/www/docs/src/content/docs/start-here/getting-started.mdx index 7e640c924..62f2dcff7 100644 --- a/www/docs/src/content/docs/start-here/getting-started.mdx +++ b/www/docs/src/content/docs/start-here/getting-started.mdx @@ -17,7 +17,7 @@ To start using Astro StudioCMS, you'll need: ## Creating an Astro Studio account :::note -Currently, Astro Studio is in closed beta, and you'll need an invite to create an account. +Astro Studio is currently in closed beta. You'll need an invite to create an account. While we understand this may be frustrating, we're following Astro Studio's News and Updates for the latest information on when the platform will be available to the public again. There is also an open [PR for `@astrojs/db`](https://github.com/withastro/astro/pull/11385) that would allow you to use the Astro StudioCMS integration without the need for Astro Studio by using another LibSQL database service or even self-hosted. ::: From 00c553ec9c5a43586c65bdcdbbd44704d37dd00a Mon Sep 17 00:00:00 2001 From: Adam Matthiesen Date: Tue, 23 Jul 2024 17:35:06 -0700 Subject: [PATCH 05/11] update config reference to use a primary point of entry to start from instead of it being just a bunch of autogenerated non-sense --- .../docs/config-reference/content-renderer.md | 18 --- .../docs/config-reference/dashboard.md | 8 +- .../docs/config-reference/date-locale.md | 17 --- .../docs/config-reference/db-start-page.md | 17 --- .../default-frontend-config.md | 82 ++++++++++++ .../docs/config-reference/image-service.md | 2 + .../config-reference/included-integrations.md | 2 + .../docs/config-reference/marked-config.md | 2 + .../docs/config-reference/options-schema.md | 122 ++++++++++++++++++ .../docs/config-reference/overrides.md | 3 +- .../content/docs/config-reference/verbose.md | 17 --- 11 files changed, 217 insertions(+), 73 deletions(-) delete mode 100644 www/docs/src/content/docs/config-reference/content-renderer.md delete mode 100644 www/docs/src/content/docs/config-reference/date-locale.md delete mode 100644 www/docs/src/content/docs/config-reference/db-start-page.md create mode 100644 www/docs/src/content/docs/config-reference/default-frontend-config.md create mode 100644 www/docs/src/content/docs/config-reference/options-schema.md delete mode 100644 www/docs/src/content/docs/config-reference/verbose.md diff --git a/www/docs/src/content/docs/config-reference/content-renderer.md b/www/docs/src/content/docs/config-reference/content-renderer.md deleted file mode 100644 index 10a458905..000000000 --- a/www/docs/src/content/docs/config-reference/content-renderer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: contentRenderer -description: A reference page for contentRenderer ---- -### `contentRenderer` - -- **Type:** `'marked'| 'markdoc' | 'astro'` -- **Default:** `marked` - -`contentRenderer` is a string value that is used to determine how content should be rendered in the `astroStudioCMS`. This is used to setup your content data. The default value is `marked` but you can also use `markdoc`. - -## Usage - -```js title="astro.config.mjs" {2} - astroStudioCMS({ - contentRenderer: 'marked', - }) -``` diff --git a/www/docs/src/content/docs/config-reference/dashboard.md b/www/docs/src/content/docs/config-reference/dashboard.md index b73da3c90..5554acec0 100644 --- a/www/docs/src/content/docs/config-reference/dashboard.md +++ b/www/docs/src/content/docs/config-reference/dashboard.md @@ -1,15 +1,17 @@ --- -title: dashboard +title: dashboardConfig description: A reference page for dashboard +sidebar: + order: 4 --- -`dashboard` option let's customize the dashboard for the `astroStudioCMS`. This is used to setup your dashboard data. +`dashboardConfig` option let's customize the dashboard for the `astroStudioCMS`. This is used to setup your dashboard data. ## Usage ```js title="astro.config.mjs" {2-24} astroStudioCMS({ - dashboard: { + dashboardConfig: { dashboardEnabled: true, faviconURL: "/favicon.ico", dashboardRouteOverride: "/components/dashboard", diff --git a/www/docs/src/content/docs/config-reference/date-locale.md b/www/docs/src/content/docs/config-reference/date-locale.md deleted file mode 100644 index 0ef32c99b..000000000 --- a/www/docs/src/content/docs/config-reference/date-locale.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: dateLocale -description: A reference page for dateLocale ---- - -- **Type:** `string` -- **Default:** `en-us` - -`dateLocale` is a string value that is used to determine how dates should be formatted in the `astroStudioCMS`. - -## Usage - -```js title="astro.config.mjs" {2} -astroStudioCMS({ - dateLocale: 'en-us', -}) -``` \ No newline at end of file diff --git a/www/docs/src/content/docs/config-reference/db-start-page.md b/www/docs/src/content/docs/config-reference/db-start-page.md deleted file mode 100644 index 3caacac26..000000000 --- a/www/docs/src/content/docs/config-reference/db-start-page.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: dbStartPage -description: A reference page for dbStartPage ---- - -- **Type:** `boolean` -- **Default:** `true` -- -`dbStartPage` is a boolean value that is used to determine if the start page should be injected into the `astroStudioCMS`. This is used to setup your DB data. - -## Usage - -```js title="astro.config.mjs" {2} -astroStudioCMS({ - dbStartPage: true, // DEFAULT - This injects a start page to setup your DB data. -}) -``` diff --git a/www/docs/src/content/docs/config-reference/default-frontend-config.md b/www/docs/src/content/docs/config-reference/default-frontend-config.md new file mode 100644 index 000000000..69d76ab27 --- /dev/null +++ b/www/docs/src/content/docs/config-reference/default-frontend-config.md @@ -0,0 +1,82 @@ +--- +title: defaultFrontEndConfig +description: A reference page for defaultFrontEndConfig +sidebar: + order: 3 +--- + +`defaultFrontEndConfig` is an object value that is used to determine how the default dashboard routes should be rendered in `astroStudioCMS`. This is used to setup your user facing front-end. + +## Usage + +```js title="astro.config.mjs" {2-9} +astroStudioCMS({ + defaultFrontEndConfig: { + injectDefaultFrontEndRoutes: true, + inject404Route: true, + htmlDefaultLanguage: 'en', + htmlDefaultHead: [], + layoutOverride: '/src/layouts/customLayout.astro', + favicon: '/favicon.svg', + }, +}) +``` + +## `injectDefaultFrontEndRoutes` + +Inject Default Routes - Injects the default routes for the StudioCMS Frontend + +- **Type:** `boolean` +- **Default:** `true` + +`injectDefaultFrontEndRoutes` is a boolean value that is used to determine if the user facing frontend routes should be injected into the `astroStudioCMS`. This is used to setup your frontend routes + +## `inject404Route` + +Inject 404 Route - Injects a 404 route for handling unknown routes + +- **Type:** `boolean` +- **Default:** `true` + +`inject404Route` is a boolean value that is used to determine if the user facing frontend `404` route should be injected into the `astroStudioCMS`. This is used to setup your frontend `404` route + +## `htmlDefaultLanguage` + +HTML Default Language - The default language for the HTML tag + +- **Type:** `string` +- **Default:** `'en'` + +`htmlDefaultLanguage` is a string value that is used to set the `lang` attribute of your `` of the `astroStudioCMS` webpage. + +## `htmlDefaultHead` + +- **Type:** `Array` +- **Default:** `optional` + +HTML Default Header - The default head configuration for the Frontend + +### Usage + + +```js title="astro.config.mjs" {2-4} +astroStudioCMS({ + htmlDefaultHead: [ + { tag: 'title', content: 'My Awesome Site' } + ], +}) +``` + +## `layoutOverride` + +Layout Override - Allows override of the default layout file + +- **Type:** `string` +- **Default:** `optional` + +## `favicon` + +- **Type:** `string` +- **Default:** `/favicon.svg` + +Favicon is relative to the project public folder diff --git a/www/docs/src/content/docs/config-reference/image-service.md b/www/docs/src/content/docs/config-reference/image-service.md index 9d1d2ef7b..6f79727a8 100644 --- a/www/docs/src/content/docs/config-reference/image-service.md +++ b/www/docs/src/content/docs/config-reference/image-service.md @@ -1,6 +1,8 @@ --- title: imageService description: A reference page for Image Service +sidebar: + order: 3 --- `imageService` is an object value that is used to determine how images should be rendered in the `astroStudioCMS`. This is used to setup your image data. diff --git a/www/docs/src/content/docs/config-reference/included-integrations.md b/www/docs/src/content/docs/config-reference/included-integrations.md index 15730c0cc..94e7c8c3a 100644 --- a/www/docs/src/content/docs/config-reference/included-integrations.md +++ b/www/docs/src/content/docs/config-reference/included-integrations.md @@ -1,6 +1,8 @@ --- title: includedIntegrations description: A reference page for includedIntegrations +sidebar: + order: 5 --- `includedIntegrations` is an object that is used to determine which Astro Integrations should be included in the `astroStudioCMS`. Currently there are three Integrations that can be included: `useAstroRobots`, `astroRobotsConfig`, and `useInoxSitemap`. diff --git a/www/docs/src/content/docs/config-reference/marked-config.md b/www/docs/src/content/docs/config-reference/marked-config.md index a7f071029..158f564c6 100644 --- a/www/docs/src/content/docs/config-reference/marked-config.md +++ b/www/docs/src/content/docs/config-reference/marked-config.md @@ -1,6 +1,8 @@ --- title: markedConfig description: A reference page for markedConfig +sidebar: + order: 2 --- `markedConfig` is an object that is used to determine how content should be rendered in the `astroStudioCMS`. This is used to setup your content data. diff --git a/www/docs/src/content/docs/config-reference/options-schema.md b/www/docs/src/content/docs/config-reference/options-schema.md new file mode 100644 index 000000000..31b0c1198 --- /dev/null +++ b/www/docs/src/content/docs/config-reference/options-schema.md @@ -0,0 +1,122 @@ +--- +title: StudioCMSOptionsSchema +description: Reference page for StudioCMSOptionsSchema +sidebar: + order: 1 +--- + +StudioCMS Integration config options schema Reference + +## `dbStartPage` + +Project Initialization Page - Used during First time setup to create your database configuration. + +- **Type:** `boolean` +- **Default:** `true` + +`dbStartPage` is a boolean value that is used to determine if the start page should be injected into the `astroStudioCMS`. This is used to setup your DB data. + +### Usage + +```js title="astro.config.mjs" {2} +studioCMS({ + dbStartPage: true, // DEFAULT - This injects a start page to setup your DB data. +}) +``` + +## `contentRenderer` + +The Markdown Content Renderer to use for rendering pages within StudioCMS + +- **Type:** `'marked'` | `'markdoc'` | `'astro'` +- **Default:** `'marked'` + +`contentRenderer` is a string value that is used to determine how content should be rendered in the `astroStudioCMS`. This is used to setup your content data. The default value is `marked` but you can also use `markdoc` or `astro`'s built in Remark processor. + +### Usage + +```js title="astro.config.mjs" {2} + astroStudioCMS({ + contentRenderer: 'marked', + }) +``` + +## `markedConfig` + +`markedConfig` is an object that is used to determine how content should be rendered in the `astroStudioCMS`. This is used to setup your content data. + +### Usage + +[see `markedConfig` for full options](/config-reference/marked-config) + +## `imageService` + +`imageService` is an object value that is used to determine how images should be rendered in the `astroStudioCMS`. This is used to setup your image data. + +### Usage + +[see `imageService` for full options](/config-reference/image-service) + +## `defaultFrontEndConfig` + +`defaultFrontEndConfig` is an object value that is used to determine how the default dashboard routes should be rendered in `astroStudioCMS`. This is used to setup your user facing front-end. + +### Usage + +[see `defaultFrontEndConfig` for full options](/config-reference/default-frontend-config) + +## `dashboardConfig` + +`dashboardConfig` option let's customize the dashboard for the `astroStudioCMS`. This is used to setup your dashboard data. + +### Usage + +[see `dashboardConfig` for full options](/config-reference/dashboard) + +## `includedIntegrations` + +`includedIntegrations` is an object that is used to determine which Astro Integrations should be included in the `astroStudioCMS`. Currently there are three Integrations that can be included: `useAstroRobots`, `astroRobotsConfig`, and `useInoxSitemap`. + +### Usage + +[see `includedIntegrations` for full options](/config-reference/included-integrations) + +## `dateLocale` + +Date locale used for formatting dates + +- **Type:** `string` +- **Default:** `en-us` + +`dateLocale` is a string value that is used to determine how dates should be formatted in the `astroStudioCMS`. + +### Usage + +```js title="astro.config.mjs" {2} +astroStudioCMS({ + dateLocale: 'en-us', +}) +``` + +## `overrides` + +`overrides` is an object that is used to override the default configuration of the `astroStudioCMS`. + +### Usage + +[see `overrides` for full options](/config-reference/overrides) + +## `verbose` + +- **Type:** `boolean| undefined` +- **Default:** `true` + +`verbose` is a boolean value that is used to determine if verbose logging should be enabled in the `astroStudioCMS`. + +### Usage + +```js title="astro.config.mjs" {2} +astroStudioCMS({ + verbose: true, // DEFAULT - This enables verbose logging in the Astro-Studio-CMS. +}), +``` \ No newline at end of file diff --git a/www/docs/src/content/docs/config-reference/overrides.md b/www/docs/src/content/docs/config-reference/overrides.md index 0b15f8c47..2df5d9242 100644 --- a/www/docs/src/content/docs/config-reference/overrides.md +++ b/www/docs/src/content/docs/config-reference/overrides.md @@ -1,6 +1,8 @@ --- title: overrides description: A reference page for overrides +sidebar: + order: 6 --- `overrides` is an object that is used to override the default configuration of the `astroStudioCMS`. @@ -10,7 +12,6 @@ description: A reference page for overrides ```js title="astro.config.mjs" {2-6} astroStudioCMS({ overrides: { - RendererOverride: "./src/components/MyCustomRenderer.astro", CustomImageOverride: "./src/components/MyCustomImage.astro", FormattedDateOverride: "./src/components/MyCustomFormattedDate.astro", }, diff --git a/www/docs/src/content/docs/config-reference/verbose.md b/www/docs/src/content/docs/config-reference/verbose.md deleted file mode 100644 index 80a616428..000000000 --- a/www/docs/src/content/docs/config-reference/verbose.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: verbose -description: A reference page for verbose ---- - -- **Type:** `boolean| undefined` -- **Default:** `true` - -`verbose` is a boolean value that is used to determine if verbose logging should be enabled in the `astroStudioCMS`. - -## Usage - -```js title="astro.config.mjs" {2} -astroStudioCMS({ - verbose: true, // DEFAULT - This enables verbose logging in the Astro-Studio-CMS. -}), -``` From b8977651f633ea0401d7c8b0167df62df6564344 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Date: Wed, 24 Jul 2024 07:00:55 -0700 Subject: [PATCH 06/11] Apply suggestions from code review Co-authored-by: Jacob Jenkins --- .../default-frontend-config.md | 12 ++++++------ .../docs/config-reference/options-schema.md | 18 +++++++++--------- .../docs/start-here/getting-started.mdx | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/www/docs/src/content/docs/config-reference/default-frontend-config.md b/www/docs/src/content/docs/config-reference/default-frontend-config.md index 69d76ab27..b9d2f2f27 100644 --- a/www/docs/src/content/docs/config-reference/default-frontend-config.md +++ b/www/docs/src/content/docs/config-reference/default-frontend-config.md @@ -5,7 +5,7 @@ sidebar: order: 3 --- -`defaultFrontEndConfig` is an object value that is used to determine how the default dashboard routes should be rendered in `astroStudioCMS`. This is used to setup your user facing front-end. +`defaultFrontEndConfig` is an object that is used to determine how the default dashboard routes should be rendered in `astroStudioCMS`. This is used to setup your user-facing front-end. ## Usage @@ -16,7 +16,7 @@ astroStudioCMS({ inject404Route: true, htmlDefaultLanguage: 'en', htmlDefaultHead: [], - layoutOverride: '/src/layouts/customLayout.astro', + layoutOverride: './src/layouts/customLayout.astro', favicon: '/favicon.svg', }, }) @@ -24,12 +24,12 @@ astroStudioCMS({ ## `injectDefaultFrontEndRoutes` -Inject Default Routes - Injects the default routes for the StudioCMS Frontend +Inject Default Routes - Injects the default routes for the StudioCMS front-end - **Type:** `boolean` - **Default:** `true` -`injectDefaultFrontEndRoutes` is a boolean value that is used to determine if the user facing frontend routes should be injected into the `astroStudioCMS`. This is used to setup your frontend routes +`injectDefaultFrontEndRoutes` Should the user facing frontend routes be injected into the `astroStudioCMS`. This is used to setup your front-end routes. ## `inject404Route` @@ -38,7 +38,7 @@ Inject 404 Route - Injects a 404 route for handling unknown routes - **Type:** `boolean` - **Default:** `true` -`inject404Route` is a boolean value that is used to determine if the user facing frontend `404` route should be injected into the `astroStudioCMS`. This is used to setup your frontend `404` route +`inject404Route` Should the `404` route be injected into the `astroStudioCMS`. This is used to setup your frontend `404` route. ## `htmlDefaultLanguage` @@ -47,7 +47,7 @@ HTML Default Language - The default language for the HTML tag - **Type:** `string` - **Default:** `'en'` -`htmlDefaultLanguage` is a string value that is used to set the `lang` attribute of your `` of the `astroStudioCMS` webpage. +`htmlDefaultLanguage` Used to set the `lang` attribute of your `` of the `astroStudioCMS` webpage. ## `htmlDefaultHead` diff --git a/www/docs/src/content/docs/config-reference/options-schema.md b/www/docs/src/content/docs/config-reference/options-schema.md index 31b0c1198..98205d856 100644 --- a/www/docs/src/content/docs/config-reference/options-schema.md +++ b/www/docs/src/content/docs/config-reference/options-schema.md @@ -14,7 +14,7 @@ Project Initialization Page - Used during First time setup to create your databa - **Type:** `boolean` - **Default:** `true` -`dbStartPage` is a boolean value that is used to determine if the start page should be injected into the `astroStudioCMS`. This is used to setup your DB data. +`dbStartPage` Should the Start page be injected into the `astroStudioCMS`. This is used to setup your DB data. ### Usage @@ -51,7 +51,7 @@ The Markdown Content Renderer to use for rendering pages within StudioCMS ## `imageService` -`imageService` is an object value that is used to determine how images should be rendered in the `astroStudioCMS`. This is used to setup your image data. +`imageService` lets you configure your which service you're using for Images. ### Usage @@ -59,7 +59,7 @@ The Markdown Content Renderer to use for rendering pages within StudioCMS ## `defaultFrontEndConfig` -`defaultFrontEndConfig` is an object value that is used to determine how the default dashboard routes should be rendered in `astroStudioCMS`. This is used to setup your user facing front-end. +`defaultFrontEndConfig` Determines how the default Dashboard routes should be rendered in `astroStudioCMS`. This is used to setup your user facing front-end. ### Usage @@ -67,7 +67,7 @@ The Markdown Content Renderer to use for rendering pages within StudioCMS ## `dashboardConfig` -`dashboardConfig` option let's customize the dashboard for the `astroStudioCMS`. This is used to setup your dashboard data. +`dashboardConfig` option lets you customize the dashboard for `astroStudioCMS`. This is used to setup your dashboard data. ### Usage @@ -75,7 +75,7 @@ The Markdown Content Renderer to use for rendering pages within StudioCMS ## `includedIntegrations` -`includedIntegrations` is an object that is used to determine which Astro Integrations should be included in the `astroStudioCMS`. Currently there are three Integrations that can be included: `useAstroRobots`, `astroRobotsConfig`, and `useInoxSitemap`. +`includedIntegrations` defines which Astro Integrations should be included in `astroStudioCMS`. Currently there are three Integrations that can be included: `useAstroRobots`, `astroRobotsConfig`, and `useInoxSitemap`. ### Usage @@ -88,7 +88,7 @@ Date locale used for formatting dates - **Type:** `string` - **Default:** `en-us` -`dateLocale` is a string value that is used to determine how dates should be formatted in the `astroStudioCMS`. +`dateLocale` specifies how dates should be formatted in `astroStudioCMS`. ### Usage @@ -100,7 +100,7 @@ astroStudioCMS({ ## `overrides` -`overrides` is an object that is used to override the default configuration of the `astroStudioCMS`. +`overrides` Used to override the default configuration of the `astroStudioCMS`. ### Usage @@ -111,12 +111,12 @@ astroStudioCMS({ - **Type:** `boolean| undefined` - **Default:** `true` -`verbose` is a boolean value that is used to determine if verbose logging should be enabled in the `astroStudioCMS`. +`verbose` enables verbose logging. ### Usage ```js title="astro.config.mjs" {2} astroStudioCMS({ - verbose: true, // DEFAULT - This enables verbose logging in the Astro-Studio-CMS. + verbose: true, // DEFAULT - This enables verbose logging in AstroStudioCMS. }), ``` \ No newline at end of file diff --git a/www/docs/src/content/docs/start-here/getting-started.mdx b/www/docs/src/content/docs/start-here/getting-started.mdx index 62f2dcff7..346332138 100644 --- a/www/docs/src/content/docs/start-here/getting-started.mdx +++ b/www/docs/src/content/docs/start-here/getting-started.mdx @@ -19,7 +19,7 @@ To start using Astro StudioCMS, you'll need: :::note Astro Studio is currently in closed beta. You'll need an invite to create an account. -While we understand this may be frustrating, we're following Astro Studio's News and Updates for the latest information on when the platform will be available to the public again. There is also an open [PR for `@astrojs/db`](https://github.com/withastro/astro/pull/11385) that would allow you to use the Astro StudioCMS integration without the need for Astro Studio by using another LibSQL database service or even self-hosted. +We're following Astro Studio's News and Updates for the latest information on when the platform will be available to the public again and will be informing everyone through our [Discord channel](https://chat.astro-studiocms.xyz) when signups for Astro Studio are open again. There is also an open [PR for `@astrojs/db`](https://github.com/withastro/astro/pull/11385) that would allow you to use the Astro StudioCMS integration without the need for Astro Studio by using another LibSQL database service or even self-hosted. ::: You can create an Astro Studio account by visiting [Astro Studio](https://studio.astro.build/). From 3a44746c2cc5b850442b29e4d817f752514fbc82 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Date: Wed, 24 Jul 2024 07:04:30 -0700 Subject: [PATCH 07/11] Update www/docs/src/content/docs/config-reference/default-frontend-config.md Co-authored-by: Jacob Jenkins --- .../docs/config-reference/default-frontend-config.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/www/docs/src/content/docs/config-reference/default-frontend-config.md b/www/docs/src/content/docs/config-reference/default-frontend-config.md index b9d2f2f27..96ba2d4bb 100644 --- a/www/docs/src/content/docs/config-reference/default-frontend-config.md +++ b/www/docs/src/content/docs/config-reference/default-frontend-config.md @@ -62,7 +62,15 @@ HTML Default Header - The default head configuration for the Frontend ```js title="astro.config.mjs" {2-4} astroStudioCMS({ htmlDefaultHead: [ - { tag: 'title', content: 'My Awesome Site' } + { tag: 'title', content: 'My Awesome Site' }, + { + tag: 'script', + attrs: { + defer: true, + src: 'https://umami.mydomain.dev/script.js', + 'data-website-id': 'my-umami-website-id', + } + } ], }) ``` From 0c117e9b6c7aa3d07ee0d326dda1d3eb34b88b93 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Date: Wed, 24 Jul 2024 08:31:32 -0700 Subject: [PATCH 08/11] Apply suggestions from code review Co-authored-by: Jacob Jenkins Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com> --- www/docs/src/content/docs/config-reference/options-schema.md | 2 +- www/docs/src/content/docs/start-here/getting-started.mdx | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/www/docs/src/content/docs/config-reference/options-schema.md b/www/docs/src/content/docs/config-reference/options-schema.md index 98205d856..7a001181b 100644 --- a/www/docs/src/content/docs/config-reference/options-schema.md +++ b/www/docs/src/content/docs/config-reference/options-schema.md @@ -31,7 +31,7 @@ The Markdown Content Renderer to use for rendering pages within StudioCMS - **Type:** `'marked'` | `'markdoc'` | `'astro'` - **Default:** `'marked'` -`contentRenderer` is a string value that is used to determine how content should be rendered in the `astroStudioCMS`. This is used to setup your content data. The default value is `marked` but you can also use `markdoc` or `astro`'s built in Remark processor. +`contentRenderer` determines how Markdown content should be rendered in `astroStudioCMS`. This is used to setup your content data. The default value is `marked` but you can also use `markdoc` or `astro` which uses Astro's built-in Remark processor. ### Usage diff --git a/www/docs/src/content/docs/start-here/getting-started.mdx b/www/docs/src/content/docs/start-here/getting-started.mdx index 346332138..cfff73486 100644 --- a/www/docs/src/content/docs/start-here/getting-started.mdx +++ b/www/docs/src/content/docs/start-here/getting-started.mdx @@ -105,7 +105,6 @@ Now that you have Astro StudioCMS installed, you can start building your project Check out how to set environment variables in Astro StudioCMS by heading to [Environment Variables](/start-here/environment-variables). -{/* TODO: Update the link when reference is started to look good */} To learn more about the API and how to use Astro StudioCMS, check out the [Astro StudioCMS Reference](/typedoc/studiocms-core/index/functions/studiocmscoreintegration/). You can also learn more about themes and how to author them by using [Astro Theme Provider](https://astro-theme-provider.netlify.app/). \ No newline at end of file From 3507d0124a99557953a637ca239315642a332405 Mon Sep 17 00:00:00 2001 From: = Date: Wed, 24 Jul 2024 21:22:30 +0100 Subject: [PATCH 09/11] Use modern html/css --- www/docs/src/components/Youtube.astro | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/www/docs/src/components/Youtube.astro b/www/docs/src/components/Youtube.astro index d00a80a69..d6e2661f6 100644 --- a/www/docs/src/components/Youtube.astro +++ b/www/docs/src/components/Youtube.astro @@ -8,6 +8,13 @@ import { YouTube } from 'astro-embed'; - @adammatthiesen */} -
+
-
+ + + From a599f7446719e76194a7daf72dd368d46cd6c299 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen Date: Wed, 24 Jul 2024 13:25:55 -0700 Subject: [PATCH 10/11] remove note, and update deployment helper action --- .../workflows/studiocms-deployment-helper-action.yml | 10 +++++----- www/docs/src/components/Youtube.astro | 7 ------- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/.github/workflows/studiocms-deployment-helper-action.yml b/.github/workflows/studiocms-deployment-helper-action.yml index 64dea4d7f..31cc1ba0e 100644 --- a/.github/workflows/studiocms-deployment-helper-action.yml +++ b/.github/workflows/studiocms-deployment-helper-action.yml @@ -18,10 +18,10 @@ jobs: issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, - body: `Deployments are available at the following URLS: - - [StudioCMS Package Demo](https://pr${{context.issue.number}}-demo.astro-studiocms.xyz) - - [StudioCMS Documentation](https://pr${{context.issue.number}}-docs.astro-studiocms.xyz) - - [StudioCMS Landing Page](https://pr${{context.issue.number}}-web.astro-studiocms.xyz) - ` + body: `@${context.payload.pull_request.user.login}, thank you for opening this pull request! + + Automated deployments are currently disabled for this project due to upstream issues. Please wait for a maintainer to review your changes and queue a deployment for you. + + If you have any questions, feel free to ask!` }) diff --git a/www/docs/src/components/Youtube.astro b/www/docs/src/components/Youtube.astro index d6e2661f6..45ee74953 100644 --- a/www/docs/src/components/Youtube.astro +++ b/www/docs/src/components/Youtube.astro @@ -1,13 +1,6 @@ --- import { YouTube } from 'astro-embed'; --- -{/* - @jdtjenkins Because i know your going to complain about the center tag... the only way i could get the Youtube Embed to center was to wrap it in a center tag. I tried using the style tag but it didn't work. If you know a better way to center the video please let me know. - - This is partially due to the internal CSS provided by astro-embed. As well as Starlight CSS - - - @adammatthiesen -*/}
From 7459f9d32ae88ca976ecaca93e792ff4fde2656e Mon Sep 17 00:00:00 2001 From: Adam Matthiesen Date: Wed, 24 Jul 2024 13:40:58 -0700 Subject: [PATCH 11/11] Publish beta.1 --- packages/studioCMS/CHANGELOG.md | 7 +++++++ packages/studioCMS/package.json | 2 +- packages/studioCMSBlog/CHANGELOG.md | 12 ++++++++++++ packages/studioCMSBlog/package.json | 2 +- 4 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 packages/studioCMS/CHANGELOG.md create mode 100644 packages/studioCMSBlog/CHANGELOG.md diff --git a/packages/studioCMS/CHANGELOG.md b/packages/studioCMS/CHANGELOG.md new file mode 100644 index 000000000..e4c3274b0 --- /dev/null +++ b/packages/studioCMS/CHANGELOG.md @@ -0,0 +1,7 @@ +# @astrolicious/studiocms + +## 0.1.0-beta.1 + +### Minor Changes + +- Initial beta release diff --git a/packages/studioCMS/package.json b/packages/studioCMS/package.json index f2331ec30..d8cbfbb32 100644 --- a/packages/studioCMS/package.json +++ b/packages/studioCMS/package.json @@ -1,6 +1,6 @@ { "name": "@astrolicious/studiocms", - "version": "0.0.0-alpha.1", + "version": "0.1.0-beta.1", "description": "A dedicated CMS for Astro Studio. Built from the ground up by the Astro community.", "author": { "name": "Adam Matthiesen | Jacob Jenkins | Paul Valladares", diff --git a/packages/studioCMSBlog/CHANGELOG.md b/packages/studioCMSBlog/CHANGELOG.md new file mode 100644 index 000000000..28040ea29 --- /dev/null +++ b/packages/studioCMSBlog/CHANGELOG.md @@ -0,0 +1,12 @@ +# @astrolicious/studiocms-blog + +## 0.1.0-beta.1 + +### Minor Changes + +- Initial beta release + +### Patch Changes + +- Updated dependencies + - @astrolicious/studiocms@0.1.0-beta.1 diff --git a/packages/studioCMSBlog/package.json b/packages/studioCMSBlog/package.json index 597341645..f0c06235b 100644 --- a/packages/studioCMSBlog/package.json +++ b/packages/studioCMSBlog/package.json @@ -1,6 +1,6 @@ { "name": "@astrolicious/studiocms-blog", - "version": "0.0.0-alpha.1", + "version": "0.1.0-beta.1", "description": "Add a blog to your StudioCMS project with ease!", "author": { "name": "Adam Matthiesen | Jacob Jenkins | Paul Valladares",