首页
/ Dillinger 技术文档

Dillinger 技术文档

2024-12-23 14:20:05作者:田桥桑Industrious

1. 安装指南

Dillinger 需要安装 Node.js 版本 10 或更高版本才能运行。首先,你需要从 Node.js 官网下载并安装 Node.js。

安装完成后,按照以下步骤安装 Dillinger:

cd dillinger
npm i
node app

对于生产环境,你需要以生产模式安装依赖项并启动服务器:

npm install --production
NODE_ENV=production node app

2. 项目使用说明

Dillinger 是一个基于 AngularJS 的 HTML5 Markdown 编辑器,具备实时预览功能。在左侧窗口输入 Markdown 文本,右侧窗口会实时显示生成的 HTML。

项目主要功能:

  • 支持从 HTML 文件导入并转换为 Markdown
  • 支持拖放图片(需要链接 Dropbox 账户)
  • 支持从 GitHub、Dropbox、Google Drive 和 OneDrive 导入和保存文件
  • 支持拖放 Markdown 和 HTML 文件到 Dillinger
  • 支持导出文档为 Markdown、HTML 和 PDF 格式

3. 项目 API 使用文档

Dillinger 项目使用了以下开源项目:

  • AngularJS:用于构建 web 应用的 HTML 增强库
  • Ace Editor:强大的基于 web 的文本编辑器
  • markdown-it:快速且易于扩展的 Markdown 解析器
  • Twitter Bootstrap:现代 web 应用的 UI 库
  • node.js:用于后端的事件驱动 I/O 库
  • Express:快速的 node.js 网络应用框架
  • Gulp:流式构建系统
  • Breakdance:HTML 转 Markdown 转换器
  • jQuery:常用的 JavaScript 库

4. 项目安装方式

除了通过 npm 安装外,Dillinger 还支持使用 Docker 容器进行安装和部署。

使用 Dockerfile 构建镜像:

cd dillinger
docker build -t <youruser>/dillinger:${package.json.version} .

替换 ${package.json.version} 为 Dillinger 的实际版本号。

启动 Docker 容器,映射端口:

docker run -d -p 8000:8080 --restart=always --cap-add=SYS_ADMIN --name=dillinger <youruser>/dillinger:${package.json.version}

在浏览器中访问服务器地址:

127.0.0.1:8000

以上就是 Dillinger 技术文档的主要内容,希望能对您使用该项目有所帮助。