Skip to content

Commit

Permalink
update mini program sdk doc (#122)
Browse files Browse the repository at this point in the history
  • Loading branch information
qkang07 authored Jan 12, 2024
1 parent ab43a9a commit 3fd1e21
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 15 deletions.
3 changes: 1 addition & 2 deletions src/assets/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
"title": "Mini Program",
"request-host": "Add the page-spy server domain to the whitelist of the miniprogram http and websocket requests. Note that the miniprogram requires https and wss protocols, except for the development environment.",
"install-sdk": "First, install dependencies in the project:",
"init-sdk": "<0>For cross platform frameworks like uniApp and Taro,import the SDK in the entry file and initialize it,check the </0> <1>configuration options</1>:",
"init-sdk-native": "For native miniprogram, you can not use node_modules directly, you have to copy the SDK file to your project path and import them:"
"init-sdk": "<0>Import the SDK in the entry file and initialize it,check the </0> <1>configuration options</1>:"
},
"end": "That's ALL.",
"start-debug": "Start debugging by clicking the <1>Connections</1> menu at the top!"
Expand Down
3 changes: 1 addition & 2 deletions src/assets/locales/ja.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
"title": "Mini Program",
"request-host": "page-spy サービスドメインを小プログラムのhttp、websocketリクエストのホワイトリストに入力します。開発環境以外では、小プログラムはhttpsとwssプロトコルの使用を強制しますので注意してください。",
"install-sdk": "まず、プロジェクトに依存関係をインストールします:",
"init-sdk": "<0>クロスプラットフォームのミニプログラムフレームワーク(uniApp、Taroなど)については、エントリーファイルでSDKをインポートし、インスタンス化します。</0> <1>構成オプション</1> を確認します:",
"init-sdk-native": "もし原生のミニプログラムであれば、node_modulesのパスを直接使用することができないため、パッケージ内のファイルを手動でプロジェクトディレクトリにコピーしてインポートする必要があります。"
"init-sdk": "<0>エントリーファイルでSDKをインポートし、インスタンス化します。</0> <1>構成オプション</1> を確認します:"
},
"end": "以上がすべてです。",
"start-debug": "<1>接続</1>メニューからトップに移動し、デバッグを開始します!"
Expand Down
3 changes: 1 addition & 2 deletions src/assets/locales/ko.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
"title": "Mini Program",
"request-host": "\"page-spy\" 서비스 도메인을 미니 프로그램의 HTTP 및 WebSocket 요청 화이트리스트에 추가하십시오. 개발 환경을 제외하고는 미니 프로그램에서는 HTTPS 및 WSS 프로토콜을 의무적으로 사용해야 합니다.",
"install-sdk": "먼저 프로젝트에 종속성을 설치하십시오:",
"init-sdk": "<0>크로스 플랫폼 미니 프로그램 프레임워크인 uniApp 및 Taro와 같은 경우, 엔트리 파일에서 SDK를 가져와 인스턴스화합니다.</0> <1>구성 옵션</1>을 확인하십시오:",
"init-sdk-native": "원래의 미니 프로그램이라면 node_modules의 경로를 직접 사용할 수 없으므로, 패키지 내 파일을 수동으로 프로젝트 디렉토리에 복사하고 가져와야 합니다."
"init-sdk": "<0>엔트리 파일에서 SDK를 가져와 인스턴스화합니다.</0> <1>구성 옵션</1>을 확인하십시오:"
},
"end": "모두 여기까지입니다.",
"start-debug": "<1>연결</1> 메뉴에서 상단으로 이동하여 디버그를 시작하세요!"
Expand Down
3 changes: 1 addition & 2 deletions src/assets/locales/zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
"title": "小程序",
"request-host": "将 page-spy 服务域名填入小程序的 http、websocket 请求白名单中。注意除了开发环境,小程序强制要求使用 https 和 wss 协议。",
"install-sdk": "首先在项目中安装依赖:",
"init-sdk": "<0>对于跨端小程序框架(uniApp, Taro 等),在入口文件中引入 SDK 并实例化,查看</0> <1>配置项</1>:",
"init-sdk-native": "如果是原生小程序,由于无法直接使用 node_modules 路径,需要手动将包中的文件复制到项目目录中引入:"
"init-sdk": "<0>在入口文件中引入 SDK 并实例化,查看</0> <1>配置项</1>:"
},
"end": "以上就是全部。",
"start-debug": "从顶部的 <1>房间列表</1> 菜单进入并开始调试!"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,6 @@ export const IntegrationWithPlatform = ({ platform, onCloseModal }: Props) => {
),
code: `// @huolala-tech/page-spy-wechat v1.6.x or upper version. \nimport PageSpy from '@huolala-tech/page-spy-wechat';\n\nnew PageSpy({
api: '${deployPath}',
})`,
lang: 'js',
},
{
title: t('inject.miniprogram.init-sdk-native'),
code: `import PageSpy from './your/path/page-spy.js';\n\nnew PageSpy({
api: '${deployPath}',
})`,
lang: 'js',
},
Expand Down

0 comments on commit 3fd1e21

Please sign in to comment.