StackEdit 技术文档

StackEdit 技术文档

stackedit In-browser Markdown editor 项目地址: https://gitcode.com/gh_mirrors/st/stackedit

1. 安装指南

1.1 通过 npm 安装

StackEdit 可以通过 npm 进行安装。首先，确保你已经安装了 Node.js 和 npm。然后，在终端中运行以下命令：

npm install stackedit

1.2 通过 Helm 部署

StackEdit 还支持通过 Helm 部署到 Kubernetes 集群。以下是部署步骤：

1. 添加 StackEdit Helm 仓库：

   helm repo add stackedit https://benweet.github.io/stackedit-charts/
   

2. 更新本地 Helm 仓库缓存：

   helm repo update
   

3. 部署 StackEdit 图表到集群：

   helm install --name stackedit stackedit/stackedit \
     --set dropboxAppKey=$DROPBOX_API_KEY \
     --set dropboxAppKeyFull=$DROPBOX_FULL_ACCESS_API_KEY \
     --set googleClientId=$GOOGLE_CLIENT_ID \
     --set googleApiKey=$GOOGLE_API_KEY \
     --set githubClientId=$GITHUB_CLIENT_ID \
     --set githubClientSecret=$GITHUB_CLIENT_SECRET \
     --set wordpressClientId=\"$WORDPRESS_CLIENT_ID\" \
     --set wordpressSecret=$WORDPRESS_CLIENT_SECRET
   

1.3 升级和卸载

• 升级 StackEdit 到最新版本：

  helm repo update
  helm upgrade stackedit stackedit/stackedit
  

• 卸载 StackEdit：

  helm delete --purge stackedit
  

2. 项目使用说明

2.1 启动开发服务器

安装依赖后，可以通过以下命令启动开发服务器：

npm start

开发服务器将在 localhost:8080 上运行，并支持热重载。

2.2 构建生产版本

要构建生产版本，请运行以下命令：

npm run build

2.3 查看构建报告

如果你想查看构建报告，可以使用以下命令：

npm run build --report

3. 项目 API 使用文档

3.1 导入 StackEdit

首先，你需要导入 StackEdit 库：

import Stackedit from 'stackedit-js';

3.2 绑定到 textarea

你可以将 StackEdit 绑定到一个 textarea 元素：

const el = document.querySelector('textarea');
const stackedit = new Stackedit();
stackedit.openFile({
  name: 'Filename',
  content: {
    text: el.value
  }
});

3.3 事件监听

StackEdit 提供了一些事件监听器，例如 fileChange 事件：

stackedit.on('fileChange', (file) => {
  console.log(file.content.text);
});

4. 项目安装方式

4.1 通过 npm 安装

npm install stackedit

4.2 通过 Helm 部署

helm repo add stackedit https://benweet.github.io/stackedit-charts/
helm repo update
helm install --name stackedit stackedit/stackedit \
  --set dropboxAppKey=$DROPBOX_API_KEY \
  --set dropboxAppKeyFull=$DROPBOX_FULL_ACCESS_API_KEY \
  --set googleClientId=$GOOGLE_CLIENT_ID \
  --set googleApiKey=$GOOGLE_API_KEY \
  --set githubClientId=$GITHUB_CLIENT_ID \
  --set githubClientSecret=$GITHUB_CLIENT_SECRET \
  --set wordpressClientId=\"$WORDPRESS_CLIENT_ID\" \
  --set wordpressSecret=$WORDPRESS_CLIENT_SECRET

通过以上步骤，你可以轻松安装和使用 StackEdit 项目。

stackedit In-browser Markdown editor 项目地址: https://gitcode.com/gh_mirrors/st/stackedit