使用必读
====

**官方网址:** https://kz16.top/showumd

推荐使用 [vscode](https://code.visualstudio.com/) 编辑和预览md文件, 更多md教程参考 https://kz16.top/md 如果[vscode](https://code.visualstudio.com/)不方便下载, 也可以用 [VSCodium](https://mirrors.tuna.tsinghua.edu.cn/github-release/VSCodium/vscodium/)

第一次启动建议运行`md2html.exe`或者`md2html.py`, 否则搜索定位不正常


- 该离线包showumd只在win系统上测试. 基于已有的开源包: `mume, caddy, geogebra, FileSaver, mermaid, katex`. 理论上可以支持其它系统, 不过需要自己替换相关开源的第三方包的可执行程序
  
- mume.exe 源于: https://www.npmjs.com/package/@shd101wyy/mume, 现在已经改名为 [crossnote](https://github.com/shd101wyy/crossnote), 协议: https://github.com/shd101wyy/crossnote/blob/develop/LICENSE.md
- caddy源于: https://github.com/caddyserver/caddy 协议: https://github.com/caddyserver/caddy/blob/master/LICENSE
- geogebra源于:  https://github.com/geogebra/geogebra 协议: https://www.geogebra.org/license 
- FileSaver.js源于: https://github.com/eligrey/FileSaver.js 协议:  https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md
- mermaid 源于: https://github.com/mermaid-js/mermaid 协议: https://github.com/mermaid-js/mermaid/blob/develop/LICENSE
- katex.css 源于: https://github.com/KaTeX/KaTeX 协议: https://github.com/KaTeX/KaTeX/blob/main/LICENSE
- kz16.css 参考了 https://github.com/benweet/stackedit 与 https://github.com/shd101wyy/vscode-markdown-preview-enhanced 以及 https://github.com/PrismJS/prism 
- md2html.exe 是通过 `nuitka --standalone --onefile md2html.py`打包得到 

请一定要遵循各自开源包的协议
请一定要遵循各自开源包的协议
请一定要遵循各自开源包的协议

这是公益项目, 没有任何广告, 也没有任何登陆注册扫码等套路, 可完全免费使用, 不可商用, 仅用于学习

==声明:== 使用该离线包出现任何问题以及纠纷等, 与本离线包制作者无关, 总之作者不承担任何责任和义务

**包里面哪些文件可以动:** `.html`和`.md`以及`.svg`的文件都可以随意修改和删除, 其余的文件不要乱动. 可以创建文件夹. 

**修改自己喜欢的logo:** 只要替换掉`kz16logo.svg`即可

---

# 第三方包的用途

- mume.exe 可把当前文件夹下面的所有md文件转化为html文件
- caddy 配合`run.bat` 可一键开启本地https服务, 然后可以访问 https://localhost
- geogebra 用于绘制和显示可交互动态图
- FileSaver.js 用于导出geogebra图为html
- mermaid 用于显示流程图和饼图等
- katex.css 用于显示公式


# why showumd

- Markdown 可以渲染动态交互文档, 支持复杂的公式, 也支持音视频. Markdown转doc与tex或html非常方便, 而且兼容性特别强.

- 信息的表达和传播的载体主要是网页(大部分app会套壳浏览器). 因此我选择md+html以及相关工具实现个人的笔记内容展现和传播.

- 个人笔记基本需求是的安全, 稳定, 简单, 方便, 免费, 开源, 免安装, 免注册登陆关注等套路

- 一直在寻找这样的软件, 希望实现: 本地编辑或修改内容之后, 可以一键上传到服务器, 同时把内容展示在个人网站上. 并且可做到, 手机电脑都能很流畅预览. 电脑端有目录树和搜索框. 经过反复摸索和测试, 发现公开的软件绝大部分背后都有着盈利的套路. 最终自己整合了好几个开源的热门项目, 实现一键批量md转html的程序(showumd), 自动上传到服务器, 并且可以完全本地化. 相比大部分笔记软件来说, 

- showumd的优势有:
  - 免费开源, 免安装, 免注册登陆, 无广告
  - 支持一键开启本地https服务, 一键转md为html, 一键部署本地md到服务器
  - 支持公式, geogebra交互动图, mermaid流程图
  - 支持目录树, 支持搜索
  - 支持运行md中的脚本