jonocodes/pwder

PWDer

将项目文档转换为完全交互式的演示，只需编写Markdown即可，所有操作在浏览器中运行，无需安装任何软件。

镜像概述

PWDer是一个工具，可将Markdown文档渲染为交互式演示页面，底层使用Play with Docker（PWD）启动虚拟机实例，用户无需本地安装Docker或其他工具。它简化了利用PWD SDK创建自定义演示的流程，无需编写HTML/Javascript或fork PWD教室仓库。

核心功能

1. 支持多种来源的Markdown文档：GitHub raw、Gist、本地示例（开发用）等
2. 提供路径简写（如/gh/对应GitHub raw，/gst/对应Gist）
3. 允许自定义Liquid模板渲染Markdown
4. 支持通过查询参数覆盖文档前置参数（如终端数量、标题）
5. 可本地部署实例，方便开发和测试

使用场景

• 展示自己的应用或项目教程，让用户直接在浏览器中互动操作
• 制作Docker相关的教学演示，无需用户安装Docker环境
• 快速生成非Docker项目的交互式文档，降低用户试用门槛

配置说明

查询参数

• doc（必填）：公开可访问的Markdown文档URL，需遵循PWD教程编写规范
  示例：/?doc=https://raw.githubusercontent.com/jonocodes/pwder/master/examples/hello.md
• template（可选）：Liquid模板URL，用于自定义渲染样式
  示例：/gh/jonocodes/pwder/master/examples/hello.md&template=https://raw.githubusercontent.com/jonocodes/pwder/master/default.html
• 前置参数（可选）：覆盖文档中的前置值，如terms=0（设置终端数量）、title=Sample（设置标题）

路径简写

• /gh/：对应GitHub raw内容，格式为/gh/用户名/仓库名/分支/路径
  示例：/gh/jonocodes/pwder/master/examples/hello.md
• /gst/：对应Gist内容，格式为/gst/用户名/gistID/raw/文件名
  示例：/gst/jonocodes/31ca8f1d33fe12fcd0b6e282a40776f2/raw/68bf014e31e9cbbdd567426f3c486892b3704eef/openfaas_kong.md
• /examples/：访问项目自带的示例文档
• /here/：访问本地目录下的文档（需设置PWDER_HERE_DIR环境变量，仅用于开发测试）

部署示例

Docker运行

bash
docker run -p 4567:4567 jonocodes/pwder

访问http://localhost:4567/即可使用。

开发模式

bash
./run.sh

启动实时开发实例，方便修改调试。

环境变量配置

设置PWDER_HERE_DIR可指定本地文档目录（仅用于测试）：

bash
PWDER_HERE_DIR=/tmp/docs ./run.sh

注意：此配置仅用于开发测试，避免设置为根目录等敏感路径，以防安全风险。