0.3.7 • Published 3 years ago
@hyiromori/markdown-preview v0.3.7
markdown-preview
Markdown realtime preview on browser with your favorite editor.
Demo
Usage
npx
$ npx @hyiromori/markdown-preview --port 34567 --file README.md
Root Directory : /current/dir
Default File : README.md
Preview URL : http://localhost:34567/
npm / yarn
$ npm install -g @hyiromori/markdown-preview
# or
$ yarn install -g @hyiromori/markdown-preview
$ markdown-preview --port 34567 --file README.md
Root Directory : /current/dir
Default File : README.md
Preview URL : http://localhost:34567/
Parameter
short | long | environment variable | parameter | required | default |
---|---|---|---|---|---|
-f | --file | MARKDOWN_PREVIEW_FILE | relative file path | no | README.md |
-t | --template | MARKDOWN_PREVIEW_TEMPLATE | template name(*1) | no | default |
-p | --port | MARKDOWN_PREVIEW_PORT | port number | no | 34567 |
--log-level | MARKDOWN_PREVIEW_LOG_LEVEL | trace, debug, infowarn, error, fatal | no | info | |
--no-opener | MARKDOWN_PREVIEW_NO_OPENER | true (only env var) | no | ||
-v | --version | no | |||
-h | --help | no |
*1: defined template name or html file path.
Defined Template Names
default
Minimum Customized Template
<!doctype html>
<html>
<head>
<title>Minimum Customized Template</title>
</head>
<body>
<pre id="raw-markdown"></pre>
<script src="/markdown-preview-websocket.js"></script>
<script type="text/javascript">
connectMarkdownPreview((changedEvent) => {
const { markdown } = changedEvent;
document.getElementById('raw-markdown').innerHTML =
markdown.replace(/</g, '<').replace(/>/g, '>');
});
</script>
</body>
</html>
0.3.7
3 years ago
0.3.6
4 years ago
0.3.5
4 years ago
0.3.4
4 years ago
0.3.3
4 years ago
0.3.2
4 years ago
0.3.1
4 years ago
0.3.0
4 years ago
0.2.9
4 years ago
0.2.8
4 years ago
0.2.7
4 years ago
0.2.6
4 years ago
0.2.5
5 years ago
0.2.4
5 years ago
0.2.3
5 years ago
0.2.2
5 years ago
0.2.1
5 years ago
0.2.0
5 years ago
0.1.10
5 years ago
0.1.9
5 years ago
0.1.8
5 years ago
0.1.7
5 years ago
0.1.6
5 years ago
0.1.5
5 years ago
0.1.4
5 years ago
0.1.3
5 years ago
0.1.2
5 years ago
0.1.1
5 years ago
0.1.0
5 years ago