A cli tool provides the ability to preview markdown files when editing, based on socket.io and chokidar, with builtin katex, highlight.js, copy, doctoc and vuepress style container support.
# install globally
npm i -g @everseen/pen
# default usage
pen
# use with cli options
pen -o -p 5000 -r ../docs
-
--help|-h
Print help message.
-
--root|-r
Set watching directory, relative path to current dir, default
.
. -
--namespace|-n
Set socket.io namespace, default
/
. -
--port|-p
Set server port, default
3000
or another auto-detected avaliable port. -
--ignores|-i
Set ignoring files, default
[]
, for example if you want to ignore dotfiles:-i "^\\."
-
--silent|-s
Ignore logger messages, default
false
. -
--open|-o
Open browser automatically, default
false
. -
--socketPath|-S
Set socket.io path, default
/pensocket.io
.
Check cli.js and server/index.ts as an example.
-
The UI looks ugly, how to customize theme?
My fault🐶, fork this project and rewrite the client part, this is a small project!.
-
Error when using namespace
/xxx
in git bash on windows?Try Power Shell, seems namespace
/doc
will be translate to/D:/<pwd>/doc
in git bash. -
I want some markdown graph tools?
Originally, I considered integrating mermaid or graphviz, but finnaly I gave up since they all required additional effort and time to learn. (And will not display without support from a tool, unlike Latex/Tex, which is widely used). I now use online tools like excalidraw for image demands.
PRs and issues are welcomed!
- 减少内存占用
- 加快处理速度
- 渐进式渲染
- 单文档模式
- 修复footnote滚动遮挡问题