#markdown #websocket-server #socket-server #unix-socket #markdown-html #markdown-server #comrak

app ws-markdown-server

一个简单的WebSocket(以及Unix套接字)服务器,用于即时编译Markdown到HTML

3 个稳定版本

1.0.2 2023年1月15日

#212 in WebSocket

自定义许可

27KB
167 代码行

Markdown 服务器

一个简单的Markdown WebSocket(和Unix套接字)服务器,由comraktokio-tungstenite支持。

安装和用法

  1. 下载docker镜像。
docker pull aalekhpatel07/ws-markdown-server:1.0.2
  1. 启动容器

注意:9004tcp端口的绑定是可选的,只有当您希望同时公开Unix套接字服务器和WebSocket服务器(WebSocket服务器运行在9003上)时才需要。

docker run \
  -d \
  -p 9003:9003 \
  -p 9004:9004 \
  --name ws-markdown-server \
  aalekhpatel07/ws-markdown-server:1.0.0

本地

您可以通过ws-markdown-server在本地机器上运行Markdown服务器

  1. 使用cargo安装它
cargo install [email protected]
  1. 启动服务器
RUST_LOG="ws_markdown_server=debug" \
    MD_SERVER_WS_PORT=9003 \
    MD_SERVER_TCP_PORT=9004 \
    MD_SERVER_HOST="0.0.0.0" \
    ws-markdown-server

测试它是否工作

  1. 您可以通过在0.0.0.0:9004打开tcp连接并向其中发送一些要转换为html的markdown文本来测试它是否工作。例如
# Start netcat once the markdown server is up and running.
nc 0.0.0.0 9004
  
# Send some markdown text to be converted to html.

> # Title
> This is some text.
> ...
> [Ctrl+D] (indicates end of file)
  
# You'll receive the html version of the sent markdown:

# <h1> Title </h1>
# <p>This is some text.</p>
# ...
  1. 或者,您还可以运行示例Svelte应用程序,该应用程序设置客户端WebSocket并使用ws-markdown-server作为其后端。
cd usage/client
npm install
npm run dev -- --port 8000 --host 0.0.0.0 --open

依赖关系

~13–25MB
~392K SLoC