markdowndocs
markdowndocs使用的
Bootstrap作为UI,其中也使用了
prettify和
scrollToTop插件。
markdown渲染使用了
markdown4j,HTML渲染和HTTPServer使用了
jsspserver。
依赖
应用依赖的jar包如下:
commons-1.0.jar- 工具类库
fastjson-1.1.24.jar- 用于JSON解析
jsspserver-1.0.jar- 用于jssp合并及HTTPServer
markdown4j-2.2.jar- 用于合并markdown
thumbnailator-0.4.7.jar- 用于生成缩略图
使用方法
Usage:
java -jar markdowndocsall.jar [-s]
不指定参数的情况下会自动生成所需的HTML文件。当指定-s参数时在端口(默认8000)上启动一下HTTP服务,在保存markdown文件时可即时查看。
Markdown语法请参看:
- https://code.google.com/p/markdown4j/
- https://github.com/rjeschke/txtmark
- http://daringfireball.net/projects/markdown/
特殊文件
markdowndocs.jsonconfig.jsonfooter.mdsummary.mdnotice.mdindex.md
多合一文件
!!EXPLAIN
h1 TITLE
h1 DESCRIPTION
!!#anc# h2 TITLE // <-- Remove leading space
h2 DESCRITPTION
功能改进
- 连接
[]()[](http://example.com)输出:
<a href="http://example.com">http://example.com</a>[!](http://example.com)输出:
<a href="http://example.com" target="_blank">http://example.com</a>[!Example](http://example.com)输出:
<a href="Example" target="_blank">http://example.com</a>
自定义扩展
Wiki方式表格输出
%%% wikiTable [class=table___table-bordered style=width:600px;]
%%%
代码美化输出
%%% prettify [ln=1 rl=1]
%%%