From 7e5bdabbaffdf10e8f106e3ab518c43c3c2ec16d Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Mon, 2 Oct 2023 14:46:32 +0200 Subject: [PATCH 1/4] fix: precompress assets --- package.json | 2 +- pnpm-lock.yaml | 24 +++++--- src/lib/utils/markdown.ts | 57 ++++++++++--------- .../[service]/descriptions/account.md | 4 +- 4 files changed, 49 insertions(+), 38 deletions(-) diff --git a/package.json b/package.json index 66b7eb4d71..f6fddb8cf3 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,7 @@ "dependencies": { "@appwrite.io/pink": "0.1.0-next.9", "@appwrite.io/pink-icons": "0.1.0-next.9", - "@appwrite.io/repo": "github:appwrite/appwrite", + "@appwrite.io/repo": "github:appwrite/appwrite#fix-specs", "@splinetool/viewer": "0.9.455", "highlight.js": "^11.8.0", "markdown-it": "^13.0.1", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 9b31a4ec82..01d33fb3a4 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -12,8 +12,8 @@ dependencies: specifier: 0.1.0-next.9 version: 0.1.0-next.9 '@appwrite.io/repo': - specifier: github:appwrite/appwrite - version: github.com/appwrite/appwrite/edf06962ec0b5a7d58d3ce1aa126e612498c9d0a + specifier: github:appwrite/appwrite#fix-specs + version: github.com/appwrite/appwrite/7b5ee34b68626e5e7ae978983ce86bc8c99d984c '@splinetool/viewer': specifier: 0.9.455 version: 0.9.455 @@ -1486,7 +1486,7 @@ packages: normalize-path: 3.0.0 readdirp: 3.6.0 optionalDependencies: - fsevents: 2.3.2 + fsevents: 2.3.3 dev: true /chownr@1.1.4: @@ -2327,6 +2327,14 @@ packages: dev: true optional: true + /fsevents@2.3.3: + resolution: {integrity: sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==} + engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} + os: [darwin] + requiresBuild: true + dev: true + optional: true + /function-bind@1.1.1: resolution: {integrity: sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==} dev: true @@ -3914,7 +3922,7 @@ packages: engines: {node: '>=14.18.0', npm: '>=8.0.0'} hasBin: true optionalDependencies: - fsevents: 2.3.2 + fsevents: 2.3.3 dev: true /run-parallel@1.2.0: @@ -4901,7 +4909,7 @@ packages: rollup: 3.28.0 sass: 1.66.1 optionalDependencies: - fsevents: 2.3.2 + fsevents: 2.3.3 dev: true /vitefu@0.2.4(vite@4.4.9): @@ -5097,8 +5105,8 @@ packages: engines: {node: '>=12.20'} dev: true - github.com/appwrite/appwrite/edf06962ec0b5a7d58d3ce1aa126e612498c9d0a: - resolution: {tarball: https://codeload.github.com/appwrite/appwrite/tar.gz/edf06962ec0b5a7d58d3ce1aa126e612498c9d0a} - name: appwrite + github.com/appwrite/appwrite/7b5ee34b68626e5e7ae978983ce86bc8c99d984c: + resolution: {tarball: https://codeload.github.com/appwrite/appwrite/tar.gz/7b5ee34b68626e5e7ae978983ce86bc8c99d984c} + name: '@appwrite.io/repo' version: 0.0.0 dev: false diff --git a/src/lib/utils/markdown.ts b/src/lib/utils/markdown.ts index 93f4d939bc..90e7e8318b 100644 --- a/src/lib/utils/markdown.ts +++ b/src/lib/utils/markdown.ts @@ -2,35 +2,38 @@ import MarkdownIt from 'markdown-it'; const md = new MarkdownIt('commonmark'); export function parse(content: string): string { - const tokens = md.parse(content, null); + const tokens = md.parse(content, null); - return md.renderer.render( - transform_tokens(tokens), - { - highlight: null - }, - null - ); + return md.renderer.render( + transform_tokens(tokens), + { + highlight: null + }, + null + ); } function transform_tokens(tokens: ReturnType): ReturnType { - return tokens.map((token) => { - if (token.children) { - token.children = transform_tokens(token.children); - } - switch (token.type) { - case 'paragraph_open': - token.attrPush(['class', 'aw-paragraph']); - break; - case 'link_open': - if (token.attrGet('href')?.startsWith('http')) { - token.attrPush(['target', '_blank']); - } - // disable links for now - token.attrSet('href', '#'); - token.attrPush(['class', 'aw-link']); - break; - } - return token; - }); + return tokens.map((token) => { + if (token.children) { + token.children = transform_tokens(token.children); + } + switch (token.type) { + case 'paragraph_open': + token.attrPush(['class', 'aw-paragraph']); + break; + case 'link_open': { + const href = token.attrGet('href'); + if (href?.startsWith('http')) { + if (!href.startsWith('https://appwrite.io')) { + token.attrPush(['rel', 'noopener noreferrer']); + token.attrPush(['target', '_blank']); + } + } + token.attrPush(['class', 'aw-link']); + break; + } + } + return token; + }); } diff --git a/src/routes/docs/references/[version]/[platform]/[service]/descriptions/account.md b/src/routes/docs/references/[version]/[platform]/[service]/descriptions/account.md index 6818115fd1..2ad8ccf219 100644 --- a/src/routes/docs/references/[version]/[platform]/[service]/descriptions/account.md +++ b/src/routes/docs/references/[version]/[platform]/[service]/descriptions/account.md @@ -1,5 +1,5 @@ The Account service allows you to authenticate and manage a user account. You can use the account service to update user information, retrieve the user sessions across different devices, and fetch the user security logs with his or her recent activity. -Register new user accounts with the [Create Account](#create), [Create Magic URL session](#createMagicURLSession), or [Create Phone session](#createPhoneSession) endpoint. You can authenticate the user account by using multiple sign-in methods available. Once the user is authenticated, a new session object will be created to allow the user to access his or her private data and settings. +Register new user accounts with the [Create Account](/docs/references/cloud/client-web/account#create), [Create Magic URL session](/docs/references/cloud/client-web/account#createMagicURLSession), or [Create Phone session](/docs/references/cloud/client-web/account#createPhoneSession) endpoint. You can authenticate the user account by using multiple sign-in methods available. Once the user is authenticated, a new session object will be created to allow the user to access his or her private data and settings. -This service also exposes an endpoint to save and read the [user preferences](#updatePrefs) as a key-value object. This feature is handy if you want to allow extra customization in your app. Common usage for this feature may include saving the user's preferred locale, timezone, or custom app theme. +This service also exposes an endpoint to save and read the [user preferences](/docs/references/cloud/client-web/account#updatePrefs) as a key-value object. This feature is handy if you want to allow extra customization in your app. Common usage for this feature may include saving the user's preferred locale, timezone, or custom app theme. From 390eda9f425df29b48469f3b571aa947897f76ef Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 13 Oct 2023 16:06:22 +0200 Subject: [PATCH 2/4] fix: package lock --- pnpm-lock.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0956a625a6..bac4ea25aa 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -13,7 +13,7 @@ dependencies: version: 0.1.0-next.9 '@appwrite.io/repo': specifier: github:appwrite/appwrite#fix-specs - version: github.com/appwrite/appwrite/c0c4cffba28cae816230a27efe9ad0b5d8f99a11 + version: github.com/appwrite/appwrite/f5d0ebeb755a2126144919a4e3b4f9e0ca509b84 '@splinetool/viewer': specifier: 0.9.455 version: 0.9.455 @@ -5570,8 +5570,8 @@ packages: engines: {node: '>=12.20'} dev: true - github.com/appwrite/appwrite/c0c4cffba28cae816230a27efe9ad0b5d8f99a11: - resolution: {tarball: https://codeload.github.com/appwrite/appwrite/tar.gz/c0c4cffba28cae816230a27efe9ad0b5d8f99a11} + github.com/appwrite/appwrite/f5d0ebeb755a2126144919a4e3b4f9e0ca509b84: + resolution: {tarball: https://codeload.github.com/appwrite/appwrite/tar.gz/f5d0ebeb755a2126144919a4e3b4f9e0ca509b84} name: '@appwrite.io/repo' version: 0.0.0 dev: false From b48f5579a8451200ec12e023a97c489b7ddc42fc Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 13 Oct 2023 16:13:37 +0200 Subject: [PATCH 3/4] fix: @appwrite/repo package branch --- package.json | 2 +- pnpm-lock.yaml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 476650482b..0863f77d7c 100644 --- a/package.json +++ b/package.json @@ -53,7 +53,7 @@ "dependencies": { "@appwrite.io/pink": "0.1.0-next.9", "@appwrite.io/pink-icons": "0.1.0-next.9", - "@appwrite.io/repo": "github:appwrite/appwrite#fix-specs", + "@appwrite.io/repo": "github:appwrite/appwrite#main", "@splinetool/viewer": "0.9.455", "compression": "^1.7.4", "express": "^4.18.2", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index bac4ea25aa..7eadfff29a 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -12,8 +12,8 @@ dependencies: specifier: 0.1.0-next.9 version: 0.1.0-next.9 '@appwrite.io/repo': - specifier: github:appwrite/appwrite#fix-specs - version: github.com/appwrite/appwrite/f5d0ebeb755a2126144919a4e3b4f9e0ca509b84 + specifier: github:appwrite/appwrite#main + version: github.com/appwrite/appwrite/fce18647d2352e4cfce7ce75fd103a21bafbf7d0 '@splinetool/viewer': specifier: 0.9.455 version: 0.9.455 @@ -5570,8 +5570,8 @@ packages: engines: {node: '>=12.20'} dev: true - github.com/appwrite/appwrite/f5d0ebeb755a2126144919a4e3b4f9e0ca509b84: - resolution: {tarball: https://codeload.github.com/appwrite/appwrite/tar.gz/f5d0ebeb755a2126144919a4e3b4f9e0ca509b84} + github.com/appwrite/appwrite/fce18647d2352e4cfce7ce75fd103a21bafbf7d0: + resolution: {tarball: https://codeload.github.com/appwrite/appwrite/tar.gz/fce18647d2352e4cfce7ce75fd103a21bafbf7d0} name: '@appwrite.io/repo' version: 0.0.0 dev: false From b18632d1e5b87fc9536eda672c9cc36b9814be78 Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 13 Oct 2023 16:17:22 +0200 Subject: [PATCH 4/4] fix: hierachy in references --- .../docs/references/[version]/[platform]/[service]/+page.svelte | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/references/[version]/[platform]/[service]/+page.svelte b/src/routes/docs/references/[version]/[platform]/[service]/+page.svelte index 0b8d941000..2c797e84a4 100644 --- a/src/routes/docs/references/[version]/[platform]/[service]/+page.svelte +++ b/src/routes/docs/references/[version]/[platform]/[service]/+page.svelte @@ -151,7 +151,7 @@
- {method.title} + {method.title}

{@html parse(method.description)}