docs: 安装方式修正为 Gitea 私有源(移除 jsDelivr/unpkg 官方源引用)
CI / test-rest (push) Successful in 9m25s
CI / e2e (push) Successful in 9m41s
CI / verify (18.x) (push) Successful in 9m50s
CI / verify (20.x) (push) Successful in 9m48s
CI / verify (24.x) (push) Successful in 9m43s
CI / test-parser (push) Successful in 9m25s
CI / test-core (push) Successful in 9m35s
CI / test-rest (push) Successful in 9m25s
CI / e2e (push) Successful in 9m41s
CI / verify (18.x) (push) Successful in 9m50s
CI / verify (20.x) (push) Successful in 9m48s
CI / verify (24.x) (push) Successful in 9m43s
CI / test-parser (push) Successful in 9m25s
CI / test-core (push) Successful in 9m35s
This commit is contained in:
@@ -52,7 +52,16 @@
|
|||||||
|
|
||||||
### 方式一:npm 安装(推荐)
|
### 方式一:npm 安装(推荐)
|
||||||
|
|
||||||
|
> 包托管于 MetonaTeam 自建 Gitea 私有 npm 源(`git.metona.cn`),不在 npm 官方源发布,安装时需指定 registry。
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# 直接指定私有源安装
|
||||||
|
npm install @metona-team/metona-editor --registry=https://git.metona.cn/api/packages/MetonaTeam/npm/
|
||||||
|
|
||||||
|
# 或配置项目 .npmrc(推荐,一次配置长期生效)
|
||||||
|
# .npmrc
|
||||||
|
@metona-team:registry=https://git.metona.cn/api/packages/MetonaTeam/npm/
|
||||||
|
|
||||||
npm install @metona-team/metona-editor
|
npm install @metona-team/metona-editor
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -78,15 +87,12 @@ const editor = MeEditor.create('#editor', { mode: 'split' });
|
|||||||
### 方式二:CDN 引入
|
### 方式二:CDN 引入
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!-- jsDelivr CDN (推荐) -->
|
<!-- Gitea 源(私有仓库需登录,公开仓库直接可访问) -->
|
||||||
<script src="https://cdn.jsdelivr.net/npm/@metona-team/metona-editor@0.4.1/dist/metona-editor.min.js"></script>
|
|
||||||
|
|
||||||
<!-- unpkg CDN -->
|
|
||||||
<script src="https://unpkg.com/@metona-team/metona-editor@0.4.1/dist/metona-editor.min.js"></script>
|
|
||||||
|
|
||||||
<!-- Gitea 源 -->
|
|
||||||
<script src="https://git.metona.cn/MetonaTeam/MetonaEditor/raw/branch/master/dist/metona-editor.js"></script>
|
<script src="https://git.metona.cn/MetonaTeam/MetonaEditor/raw/branch/master/dist/metona-editor.js"></script>
|
||||||
|
|
||||||
|
<!-- 本地构建产物(下载 dist 后引入) -->
|
||||||
|
<script src="./dist/metona-editor.min.js"></script>
|
||||||
|
|
||||||
<div id="editor"></div>
|
<div id="editor"></div>
|
||||||
<script>
|
<script>
|
||||||
const editor = MeEditor.create('#editor', { mode: 'split' });
|
const editor = MeEditor.create('#editor', { mode: 'split' });
|
||||||
|
|||||||
+2
-2
@@ -203,8 +203,8 @@ var demoMd=[
|
|||||||
'```',
|
'```',
|
||||||
'',
|
'',
|
||||||
'```bash',
|
'```bash',
|
||||||
'# 安装与启动',
|
'# 安装(Gitea 私有源)',
|
||||||
'npm install @metona-team/metona-editor',
|
'npm install @metona-team/metona-editor --registry=https://git.metona.cn/api/packages/MetonaTeam/npm/',
|
||||||
'npm run dev',
|
'npm run dev',
|
||||||
'```',
|
'```',
|
||||||
'',
|
'',
|
||||||
|
|||||||
+5
-2
@@ -109,8 +109,11 @@ footer a{color:var(--accent);text-decoration:none}
|
|||||||
<!-- 快速入门 -->
|
<!-- 快速入门 -->
|
||||||
<section id="quickstart">
|
<section id="quickstart">
|
||||||
<h2>安装与引入</h2>
|
<h2>安装与引入</h2>
|
||||||
<pre><span class="c-com"># npm 安装</span>
|
<pre><span class="c-com"># npm 安装(Gitea 私有源)</span>
|
||||||
<span class="c-kw">npm</span> install @metona-team/metona-editor
|
<span class="c-kw">npm</span> install @metona-team/metona-editor <span class="c-punc">--</span>registry<span class="c-punc">=</span>https<span class="c-punc">:</span><span class="c-punc">//</span>git<span class="c-punc">.</span>metona<span class="c-punc">.</span>cn<span class="c-punc">/</span>api<span class="c-punc">/</span>packages<span class="c-punc">/</span>MetonaTeam<span class="c-punc">/</span>npm<span class="c-punc">/</span>
|
||||||
|
|
||||||
|
<span class="c-com">// 或项目 .npmrc 配置 scope 后直接安装</span>
|
||||||
|
<span class="c-com">// @metona-team:registry=https://git.metona.cn/api/packages/MetonaTeam/npm/</span>
|
||||||
|
|
||||||
<span class="c-com">// TypeScript / ES Module</span>
|
<span class="c-com">// TypeScript / ES Module</span>
|
||||||
<span class="c-kw">import</span> MeEditor <span class="c-kw">from</span> <span class="c-str">'@metona-team/metona-editor'</span><span class="c-punc">;</span>
|
<span class="c-kw">import</span> MeEditor <span class="c-kw">from</span> <span class="c-str">'@metona-team/metona-editor'</span><span class="c-punc">;</span>
|
||||||
|
|||||||
+4
-4
@@ -157,8 +157,8 @@ footer a:hover{text-decoration:underline}
|
|||||||
<span class="section-eyebrow">Quick Start</span>
|
<span class="section-eyebrow">Quick Start</span>
|
||||||
<h2 class="section-title">三行代码即可使用</h2>
|
<h2 class="section-title">三行代码即可使用</h2>
|
||||||
<p class="section-sub">npm / CDN / 本地文件 三种方式,TypeScript / ESM / CJS 全面支持。</p>
|
<p class="section-sub">npm / CDN / 本地文件 三种方式,TypeScript / ESM / CJS 全面支持。</p>
|
||||||
<div class="code-block"><span class="c-com">// 方式一:npm 安装(推荐)</span>
|
<div class="code-block"><span class="c-com">// 方式一:npm 安装(Gitea 私有源)</span>
|
||||||
<span class="c-kw">npm</span> install @metona-team/metona-editor
|
<span class="c-kw">npm</span> install @metona-team/metona-editor <span class="c-punc">--</span>registry<span class="c-punc">=</span>https<span class="c-punc">:</span><span class="c-punc">//</span>git<span class="c-punc">.</span>metona<span class="c-punc">.</span>cn<span class="c-punc">/</span>api<span class="c-punc">/</span>packages<span class="c-punc">/</span>MetonaTeam<span class="c-punc">/</span>npm<span class="c-punc">/</span>
|
||||||
|
|
||||||
<span class="c-com">// ES Module / TypeScript</span>
|
<span class="c-com">// ES Module / TypeScript</span>
|
||||||
<span class="c-kw">import</span> MeEditor <span class="c-kw">from</span> <span class="c-str">'@metona-team/metona-editor'</span><span class="c-punc">;</span>
|
<span class="c-kw">import</span> MeEditor <span class="c-kw">from</span> <span class="c-str">'@metona-team/metona-editor'</span><span class="c-punc">;</span>
|
||||||
@@ -166,8 +166,8 @@ footer a:hover{text-decoration:underline}
|
|||||||
<span class="c-com">// CommonJS</span>
|
<span class="c-com">// CommonJS</span>
|
||||||
<span class="c-kw">const</span> MeEditor <span class="c-punc">=</span> <span class="c-fn">require</span><span class="c-punc">(</span><span class="c-str">'@metona-team/metona-editor'</span><span class="c-punc">);</span>
|
<span class="c-kw">const</span> MeEditor <span class="c-punc">=</span> <span class="c-fn">require</span><span class="c-punc">(</span><span class="c-str">'@metona-team/metona-editor'</span><span class="c-punc">);</span>
|
||||||
|
|
||||||
<span class="c-com">// 方式二:CDN 引入</span>
|
<span class="c-com">// 方式二:Gitea raw 引入</span>
|
||||||
<span class="c-com"><script src="https://cdn.jsdelivr.net/npm/@metona-team/metona-editor@0.4.1/dist/metona-editor.min.js"></script></span>
|
<span class="c-com"><script src="https://git.metona.cn/MetonaTeam/MetonaEditor/raw/branch/master/dist/metona-editor.js"></script></span>
|
||||||
|
|
||||||
<span class="c-com">// 方式三:本地文件</span>
|
<span class="c-com">// 方式三:本地文件</span>
|
||||||
<span class="c-com"><script src="./dist/metona-editor.min.js"></script></span>
|
<span class="c-com"><script src="./dist/metona-editor.min.js"></script></span>
|
||||||
|
|||||||
Reference in New Issue
Block a user