📜  typebr (1)

📅  最后修改于: 2023-12-03 15:20:42.162000             🧑  作者: Mango

Typebr

Typebr是一款针对程序员的在线Markdown编辑器,支持实时预览和导出Markdown文档,还提供了丰富的编辑和导出选项,让你的文档更加的易读易写。

特性
  • 实时Markdown渲染
  • 语法高亮
  • 导出为HTML、PDF、Markdown、Word等格式
  • 支持代码块、表格、图片、超链接等Markdown语法
  • 支持自定义样式和配置参数
贡献者
  • @user1
  • @user2
  • @user3
安装
npm install typebr --save
使用
引入
import Typebr from 'typebr';

const typebr = new Typebr('#editor', {
  // 自定义配置
});
API

setValue(val: string)

设置编辑器的值。

typebr.setValue('# Hello World!')

getValue(): string

获取编辑器的值。

const value = typebr.getValue();
事件

change

当编辑器的值发生改变时触发。

typebr.on('change', function(value) {
  console.log(value);
});
导出

Typebr支持导出为HTML、PDF、Markdown、Word等格式,为了达到更好的导出效果,你可以通过setOption方法来自定义导出配置。

typebr.setOption('export', {
  // 导出配置
});

typebr.exportAsPDF()
  .then(doc => {
    // 成功导出PDF
  })
  .catch(err => {
    // 导出PDF失败
  });
自定义

Typebr支持自定义配置,你可以通过以下方式来实现:

typebr.setOption('toolbar', true);

typebr.setOption('markdownOption', {
  // Markdown配置
});

更多自定义配置,欢迎访问在线文档

效果预览

Typebr Editor

维护者
  • @typebr
  • @user1
  • @user2
  • @user3
许可证

MIT License.