@everseenflash/pen-middleware v3.3.0

@everseenflash/pen-middleware

一个cli工具，提供对markdown文件的预览能力。也可用作http中间件。基于socket.io。灵感来源自pen。

Usage

Use with CLI

# install globally
npm i -g @everseenflash/pen-middleware
# default usage
pen
# use with simple options
pen -si -p 8080 ~/docs

Cli Options

• --help|-h

help.

• --port|-p

设置port，默认3000。

• --root|-r

设置markdown文件目录，默认'./'。

• -i

是否显示隐藏文件，默认不显示。

• -s

是否输出日志，默认输出。

Use with Node.js API

Just check pen.js as an example.

Embedded markdown-it plugins

默认集成了一些markdown-it插件：

• markdown-it-anchor
• markdown-it-container

include three containers: Warn|Error|Info, vuepress style like

::: Warn
balabala
:::

• markdown-it-highlightjs
• markdown-it-footnote
• markdown-it-toc-done-right
• markdown-it-katex (forked, update to katex@0.13.11)
• markdown-it-mermaid (forked, update to mermaid@8.10.2)

Q&A

• Diffrent namespaces?

Pen force to use default namespace '/', different namespace is not support yet.

• Custom UI?

Just fork this project and modify it! It is quite a simple project. Otherwise you can use your own middleware.

• ENOSPC: System limit for number of file watchers reached

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p