{"id":17489414,"url":"https://github.com/zhangjikai/online-markdown-reader","last_synced_at":"2026-02-21T03:31:37.186Z","repository":{"id":88159255,"uuid":"77321166","full_name":"zhangjikai/online-markdown-reader","owner":"zhangjikai","description":"Markdown  在线阅读器","archived":false,"fork":false,"pushed_at":"2025-04-02T12:24:01.000Z","size":16412,"stargazers_count":46,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-05T09:07:36.182Z","etag":null,"topics":["markdown-viewer"],"latest_commit_sha":null,"homepage":"http://markdown.zhangjikai.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhangjikai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-12-25T10:33:43.000Z","updated_at":"2025-04-02T12:24:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"2dfb0c13-81f1-4d76-b882-a8ff146eef00","html_url":"https://github.com/zhangjikai/online-markdown-reader","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/zhangjikai/online-markdown-reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangjikai%2Fonline-markdown-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangjikai%2Fonline-markdown-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangjikai%2Fonline-markdown-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangjikai%2Fonline-markdown-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhangjikai","download_url":"https://codeload.github.com/zhangjikai/online-markdown-reader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangjikai%2Fonline-markdown-reader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29672704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T03:11:15.450Z","status":"ssl_error","status_checked_at":"2026-02-21T03:10:34.920Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown-viewer"],"created_at":"2024-10-19T05:42:41.849Z","updated_at":"2026-02-21T03:31:37.178Z","avatar_url":"https://github.com/zhangjikai.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Online markdown reader\nMarkdown 在线阅读器。\n\n\u003c!-- toc --\u003e\n\n- [功能](#%E5%8A%9F%E8%83%BD)\n- [示例](#%E7%A4%BA%E4%BE%8B)\n- [扩展语法](#%E6%89%A9%E5%B1%95%E8%AF%AD%E6%B3%95)\n  * [Todo列表](#todo%E5%88%97%E8%A1%A8)\n  * [Mathjax](#mathjax)\n  * [时序图](#时序图)\n  * [Emoji](#emoji)\n  * [ECharts](#echarts)\n    * [配置](#配置)\n  * [自定义扩展](#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%89%A9%E5%B1%95)\n- [导出](#%E5%AF%BC%E5%87%BA)\n  * [多说评论框](#%E5%A4%9A%E8%AF%B4%E8%AF%84%E8%AE%BA%E6%A1%86)\n- [其他说明](#%E5%85%B6%E4%BB%96%E8%AF%B4%E6%98%8E)\n  * [Markdown 文件解析](#markdown-%E6%96%87%E4%BB%B6%E8%A7%A3%E6%9E%90)\n  * [Markdown 样式](#markdown-%E6%A0%B7%E5%BC%8F)\n  * [本地图片](#%E6%9C%AC%E5%9C%B0%E5%9B%BE%E7%89%87)\n  * [目录](#%E7%9B%AE%E5%BD%95)\n  * [缓存](#%E7%BC%93%E5%AD%98)\n\u003c!-- tocstop --\u003e\n\n## 功能\n\n+ `Prism.js` / `Highlight.js` 代码高亮\n+ 自动生成目录\n+ 本地图片显示\n+ 导出 Html （包含样式）\n    - BackToTop\n    - 多说\n+ 扩展功能\n    - Toto 列表\n    - [MathJax](https://github.com/mathjax/MathJax) \n    - [时序图 (Js sequence diagrams)](https://github.com/bramp/js-sequence-diagrams)\n    - [Emoji (Emojify.js)](https://github.com/Ranks/emojify.js)\n    - [ECharts](http://echarts.baidu.com/)\n    - [Fancybox](http://fancybox.net/)\n\n## 示例\n[示例文件](demo/sample.md)    [示例预览](http://zhangjikai.com/markdown/sample.html)\n## 扩展语法\n### Todo列表\n```\n- [x] 完成\n- [ ] 未完成\n- [ ] 未完成\n```\n\n### Mathjax\n支持原生的 Mathjax 语法。示例代码：\n```\n$$\n        \\begin{matrix}\n        1 \u0026 x \u0026 x^2 \\\\\n        1 \u0026 y \u0026 y^2 \\\\\n        1 \u0026 z \u0026 z^2 \\\\\n        \\end{matrix}\n$$\n```\n关于Mathjax 语法，请参考[MathJax basic tutorial and quick reference](http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference/5044)\n\n不过直接使用原生的 Mathjax 语法，marked 会将公式中的 `\\\\` 转为 `\\`，导致换行失效，为了解决这个问题，这里做了一下扩展，将 Mathjax 代码放入代码块中，代码块语言设为 `mathjax` 即可。如下面的示例\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```mathjax\n$$\n        \\begin{matrix}\n        1 \u0026 x \u0026 x^2 \\\\\n        1 \u0026 y \u0026 y^2 \\\\\n        1 \u0026 z \u0026 z^2 \\\\\n        \\end{matrix}\n$$\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n\n### 时序图\n在 Markdown 文档中添加下面的代码块，会将代码块中的代码解析为时序图\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```seq\nA-\u003eB: Normal line\nB--\u003eC: Dashed line\nC-\u003e\u003eD: Open arrow\nD--\u003e\u003eA: Dashed open arrow\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n### Emoji\nEmoji表情参见 [EMOJI CHEAT SHEET](http://www.webpagefx.com/tools/emoji-cheat-sheet/)\n\n### ECharts\n在文档中加入下面的代码块，会将代码块中代码解析为 [ECharts](http://echarts.baidu.com/) 图表。只支持默认的数据显示，无法添加自定义的事件处理。\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```echarts\n{\n    title: {\n        text: 'ECharts 入门示例'\n    },\n    tooltip: {},\n    legend: {\n        data:['销量']\n    },\n    xAxis: {\n        data: [\"衬衫\",\"羊毛衫\",\"雪纺衫\",\"裤子\",\"高跟鞋\",\"袜子\"]\n    },\n    yAxis: {},\n    series: [{\n        name: '销量',\n        type: 'bar',\n        data: [5, 20, 36, 10, 10, 20]\n    }]\n}\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n#### 配置\n目前自定义了三个配置项：\n* **`width`**： 图表宽度，可选，默认值是 `100%` \n* **`height`**: 图表高度，可选，默认值是 `400px`\n* **`theme`**: 图标主题，可选，有效的主题是： `dark`, `infographic`, `macarons`, `roma`, `shine`, `vintage`\n\n其余的参数都是 ECharts 中定义的参数，具体的参考 [ECharts 配置](http://echarts.baidu.com/option.html#title)。下面是一个完整示例\n```\n{\n    width: \"600px\",\n    height: \"400px\",\n    theme: \"macarons\",\n    title: {\n        text: 'ECharts 入门示例'\n    },\n    tooltip: {},\n    legend: {\n        data:['销量']\n    },\n    xAxis: {\n        data: [\"衬衫\",\"羊毛衫\",\"雪纺衫\",\"裤子\",\"高跟鞋\",\"袜子\"]\n    },\n    yAxis: {},\n    series: [{\n        name: '销量',\n        type: 'bar',\n        data: [5, 20, 36, 10, 10, 20]\n    }]\n}\n```\n### 自定义扩展\n在现有程序的基础上，我们可以很方便的添加扩展功能。基本流程大概就是引入扩展的库文件，在渲染 Markdown 文件时 调用库文件相应的方法。以添加时序图为例：  \n\n* 确定时序图的代码标记\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```seq\n时序图代码\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n* 修改 `marked` 中对于代码块的解析函数，添加对于时序图标记的支持\n```js\nvar renderer = new marked.Renderer();\nvar originalCodeFun = renderer.code;\nrenderer.code = function (code, language) {\n    if (language == \"seq\") {\n        return \"\u003cdiv class='diagram' id='diagram'\u003e\" + code + \"\u003c/div\u003e\"\n    } else {\n        return originalCodeFun.call(this, code, language);\n    }\n};\nmarked.setOptions({\n    renderer: renderer\n});\n```\n* 引入 `js-sequence-diagrams` 相关文件\n```js\n\u003clink href=\"{{ bower directory }}/js-sequence-diagrams/dist/sequence-diagram-min.css\" rel=\"stylesheet\" /\u003e\n\u003cscript src=\"{{ bower directory }}/bower-webfontloader/webfont.js\" /\u003e\n\u003cscript src=\"{{ bower directory }}/snap.svg/dist/snap.svg-min.js\" /\u003e\n\u003cscript src=\"{{ bower directory }}/underscore/underscore-min.js\" /\u003e\n\u003cscript src=\"{{ bower directory }}/js-sequence-diagrams/dist/sequence-diagram-min.js\" /\u003e\n```\n* 渲染 Markdown 文件时，调用相关函数\n```js\n$(\".diagram\").sequenceDiagram({theme: 'simple'});\n```\n\n如果不需要某个扩展功能，可以停用该功能，以加快文件渲染的速度。\n\n## 导出\n### 多说评论框\n通过在 Markdown 文件中添加下面代码来配置多说\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```duoshuo\n{\n    \"key\": \"filename\",\n    \"title\": \"filename\",\n    \"url\": \"filename.html\",\n    \"short_name\": \"shortname\"\n}\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n## 其他说明\n\n### Markdown 文件解析\n程序使用 [marked](https://github.com/chjj/marked) 解析文件。\n\n### Markdown 样式\n`Markdown` 的显示样式都在 `assets/css/markdown.css` 里，如果需要自定义样式，只需修改这个文件。\n\n### 本地图片\n如果需要显示本地图片，需要手动的将图片上传一下（支持批量上传），程序使用 `FileReader` 读取上传的图片，然后将图片的本地路径替换为图片的内容。图片压缩对 `jpg` 文件效果较好，对于 `png` 文件效果较差。\n\n### 目录\n在需要生成目录的地方加上下面的代码\n```\n\u003c!-- toc --\u003e\n```\n如果不加会自动在开头生成。\n\n### 缓存\n上次打开的文件和配置信息都保存在 `localStorage` 里，如果清理了缓存，就可能丢失这些信息。另外浏览器对于 `localStorage` 的容量有限制，所以不要保存太大的文件。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhangjikai%2Fonline-markdown-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhangjikai%2Fonline-markdown-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhangjikai%2Fonline-markdown-reader/lists"}